com.pulumi.aws.waf.Rule Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.waf;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.waf.RuleArgs;
import com.pulumi.aws.waf.inputs.RuleState;
import com.pulumi.aws.waf.outputs.RulePredicate;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a WAF Rule Resource
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.waf.IpSet;
* import com.pulumi.aws.waf.IpSetArgs;
* import com.pulumi.aws.waf.inputs.IpSetIpSetDescriptorArgs;
* import com.pulumi.aws.waf.Rule;
* import com.pulumi.aws.waf.RuleArgs;
* import com.pulumi.aws.waf.inputs.RulePredicateArgs;
* import com.pulumi.resources.CustomResourceOptions;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var ipset = new IpSet("ipset", IpSetArgs.builder()
* .name("tfIPSet")
* .ipSetDescriptors(IpSetIpSetDescriptorArgs.builder()
* .type("IPV4")
* .value("192.0.7.0/24")
* .build())
* .build());
*
* var wafrule = new Rule("wafrule", RuleArgs.builder()
* .name("tfWAFRule")
* .metricName("tfWAFRule")
* .predicates(RulePredicateArgs.builder()
* .dataId(ipset.id())
* .negated(false)
* .type("IPMatch")
* .build())
* .build(), CustomResourceOptions.builder()
* .dependsOn(ipset)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import WAF rules using the id. For example:
*
* ```sh
* $ pulumi import aws:waf/rule:Rule example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
* ```
*
*/
@ResourceType(type="aws:waf/rule:Rule")
public class Rule extends com.pulumi.resources.CustomResource {
/**
* The ARN of the WAF rule.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The ARN of the WAF rule.
*
*/
public Output arn() {
return this.arn;
}
/**
* The name or description for the Amazon CloudWatch metric of this rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
*
*/
@Export(name="metricName", refs={String.class}, tree="[0]")
private Output metricName;
/**
* @return The name or description for the Amazon CloudWatch metric of this rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace.
*
*/
public Output metricName() {
return this.metricName;
}
/**
* The name or description of the rule.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name or description of the rule.
*
*/
public Output name() {
return this.name;
}
/**
* The objects to include in a rule (documented below).
*
*/
@Export(name="predicates", refs={List.class,RulePredicate.class}, tree="[0,1]")
private Output> predicates;
/**
* @return The objects to include in a rule (documented below).
*
*/
public Output>> predicates() {
return Codegen.optional(this.predicates);
}
/**
* Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return Key-value map of resource tags. .If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Rule(java.lang.String name) {
this(name, RuleArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Rule(java.lang.String name, RuleArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Rule(java.lang.String name, RuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:waf/rule:Rule", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Rule(java.lang.String name, Output id, @Nullable RuleState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:waf/rule:Rule", name, state, makeResourceOptions(options, id), false);
}
private static RuleArgs makeArgs(RuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? RuleArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Rule get(java.lang.String name, Output id, @Nullable RuleState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Rule(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy