com.pulumi.aws.waf.RateBasedRule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** 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.RateBasedRuleArgs;
import com.pulumi.aws.waf.inputs.RateBasedRuleState;
import com.pulumi.aws.waf.outputs.RateBasedRulePredicate;
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.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a WAF Rate Based 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.RateBasedRule;
* import com.pulumi.aws.waf.RateBasedRuleArgs;
* import com.pulumi.aws.waf.inputs.RateBasedRulePredicateArgs;
* 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 RateBasedRule("wafrule", RateBasedRuleArgs.builder()
* .name("tfWAFRule")
* .metricName("tfWAFRule")
* .rateKey("IP")
* .rateLimit(100)
* .predicates(RateBasedRulePredicateArgs.builder()
* .dataId(ipset.id())
* .negated(false)
* .type("IPMatch")
* .build())
* .build(), CustomResourceOptions.builder()
* .dependsOn(ipset)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import WAF Rated Based Rule using the id. For example:
*
* ```sh
* $ pulumi import aws:waf/rateBasedRule:RateBasedRule wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
* ```
*
*/
@ResourceType(type="aws:waf/rateBasedRule:RateBasedRule")
public class RateBasedRule extends com.pulumi.resources.CustomResource {
/**
* Amazon Resource Name (ARN)
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return Amazon Resource Name (ARN)
*
*/
public Output arn() {
return this.arn;
}
/**
* The name or description for the Amazon CloudWatch metric of this rule.
*
*/
@Export(name="metricName", refs={String.class}, tree="[0]")
private Output metricName;
/**
* @return The name or description for the Amazon CloudWatch metric of this rule.
*
*/
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,RateBasedRulePredicate.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);
}
/**
* Valid value is IP.
*
*/
@Export(name="rateKey", refs={String.class}, tree="[0]")
private Output rateKey;
/**
* @return Valid value is IP.
*
*/
public Output rateKey() {
return this.rateKey;
}
/**
* The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. Minimum value is 100.
*
*/
@Export(name="rateLimit", refs={Integer.class}, tree="[0]")
private Output rateLimit;
/**
* @return The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. Minimum value is 100.
*
*/
public Output rateLimit() {
return this.rateLimit;
}
/**
* 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 RateBasedRule(java.lang.String name) {
this(name, RateBasedRuleArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public RateBasedRule(java.lang.String name, RateBasedRuleArgs 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 RateBasedRule(java.lang.String name, RateBasedRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:waf/rateBasedRule:RateBasedRule", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private RateBasedRule(java.lang.String name, Output id, @Nullable RateBasedRuleState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:waf/rateBasedRule:RateBasedRule", name, state, makeResourceOptions(options, id), false);
}
private static RateBasedRuleArgs makeArgs(RateBasedRuleArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? RateBasedRuleArgs.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 RateBasedRule get(java.lang.String name, Output id, @Nullable RateBasedRuleState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new RateBasedRule(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy