class CfnRuleGroup (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.WAFv2.CfnRuleGroup |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnRuleGroup |
 Java | software.amazon.awscdk.services.wafv2.CfnRuleGroup |
 Python | aws_cdk.aws_wafv2.CfnRuleGroup |
 TypeScript | aws-cdk-lib » aws_wafv2 » CfnRuleGroup |
Implements
IConstruct, IDependable, IInspectable, ITaggable
This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.
For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .
Use an RuleGroup to define a collection of rules for inspecting and controlling web requests. You use a rule group in an WebACL by providing its Amazon Resource Name (ARN) to the rule statement RuleGroupReferenceStatement , when you add rules to the web ACL.
When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-rulegroup.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';
declare const all: any;
declare const allow: any;
declare const allQueryArguments: any;
declare const block: any;
declare const captcha: any;
declare const challenge: any;
declare const count: any;
declare const forwardedIp: any;
declare const httpMethod: any;
declare const ip: any;
declare const method: any;
declare const queryString: any;
declare const singleHeader: any;
declare const singleQueryArgument: any;
declare const statementProperty_: wafv2.CfnRuleGroup.StatementProperty;
declare const uriPath: any;
const cfnRuleGroup = new wafv2.CfnRuleGroup(this, 'MyCfnRuleGroup', {
capacity: 123,
scope: 'scope',
visibilityConfig: {
cloudWatchMetricsEnabled: false,
metricName: 'metricName',
sampledRequestsEnabled: false,
},
// the properties below are optional
availableLabels: [{
name: 'name',
}],
consumedLabels: [{
name: 'name',
}],
customResponseBodies: {
customResponseBodiesKey: {
content: 'content',
contentType: 'contentType',
},
},
description: 'description',
name: 'name',
rules: [{
name: 'name',
priority: 123,
statement: {
andStatement: {
statements: [statementProperty_],
},
byteMatchStatement: {
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
positionalConstraint: 'positionalConstraint',
textTransformations: [{
priority: 123,
type: 'type',
}],
// the properties below are optional
searchString: 'searchString',
searchStringBase64: 'searchStringBase64',
},
geoMatchStatement: {
countryCodes: ['countryCodes'],
forwardedIpConfig: {
fallbackBehavior: 'fallbackBehavior',
headerName: 'headerName',
},
},
ipSetReferenceStatement: {
arn: 'arn',
// the properties below are optional
ipSetForwardedIpConfig: {
fallbackBehavior: 'fallbackBehavior',
headerName: 'headerName',
position: 'position',
},
},
labelMatchStatement: {
key: 'key',
scope: 'scope',
},
notStatement: {
statement: statementProperty_,
},
orStatement: {
statements: [statementProperty_],
},
rateBasedStatement: {
aggregateKeyType: 'aggregateKeyType',
limit: 123,
// the properties below are optional
customKeys: [{
cookie: {
name: 'name',
textTransformations: [{
priority: 123,
type: 'type',
}],
},
forwardedIp: forwardedIp,
header: {
name: 'name',
textTransformations: [{
priority: 123,
type: 'type',
}],
},
httpMethod: httpMethod,
ip: ip,
labelNamespace: {
namespace: 'namespace',
},
queryArgument: {
name: 'name',
textTransformations: [{
priority: 123,
type: 'type',
}],
},
queryString: {
textTransformations: [{
priority: 123,
type: 'type',
}],
},
uriPath: {
textTransformations: [{
priority: 123,
type: 'type',
}],
},
}],
evaluationWindowSec: 123,
forwardedIpConfig: {
fallbackBehavior: 'fallbackBehavior',
headerName: 'headerName',
},
scopeDownStatement: statementProperty_,
},
regexMatchStatement: {
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
regexString: 'regexString',
textTransformations: [{
priority: 123,
type: 'type',
}],
},
regexPatternSetReferenceStatement: {
arn: 'arn',
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
textTransformations: [{
priority: 123,
type: 'type',
}],
},
sizeConstraintStatement: {
comparisonOperator: 'comparisonOperator',
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
size: 123,
textTransformations: [{
priority: 123,
type: 'type',
}],
},
sqliMatchStatement: {
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
textTransformations: [{
priority: 123,
type: 'type',
}],
// the properties below are optional
sensitivityLevel: 'sensitivityLevel',
},
xssMatchStatement: {
fieldToMatch: {
allQueryArguments: allQueryArguments,
body: {
oversizeHandling: 'oversizeHandling',
},
cookies: {
matchPattern: {
all: all,
excludedCookies: ['excludedCookies'],
includedCookies: ['includedCookies'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
headers: {
matchPattern: {
all: all,
excludedHeaders: ['excludedHeaders'],
includedHeaders: ['includedHeaders'],
},
matchScope: 'matchScope',
oversizeHandling: 'oversizeHandling',
},
ja3Fingerprint: {
fallbackBehavior: 'fallbackBehavior',
},
jsonBody: {
matchPattern: {
all: all,
includedPaths: ['includedPaths'],
},
matchScope: 'matchScope',
// the properties below are optional
invalidFallbackBehavior: 'invalidFallbackBehavior',
oversizeHandling: 'oversizeHandling',
},
method: method,
queryString: queryString,
singleHeader: singleHeader,
singleQueryArgument: singleQueryArgument,
uriPath: uriPath,
},
textTransformations: [{
priority: 123,
type: 'type',
}],
},
},
visibilityConfig: {
cloudWatchMetricsEnabled: false,
metricName: 'metricName',
sampledRequestsEnabled: false,
},
// the properties below are optional
action: {
allow: allow,
block: block,
captcha: captcha,
challenge: challenge,
count: count,
},
captchaConfig: {
immunityTimeProperty: {
immunityTime: 123,
},
},
challengeConfig: {
immunityTimeProperty: {
immunityTime: 123,
},
},
ruleLabels: [{
name: 'name',
}],
}],
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnRuleGroup(scope: Construct, id: string, props: CfnRuleGroupProps)
Parameters
- scope
Construct— Scope in which this resource is defined. - id
string— Construct identifier for this resource (unique in its scope). - props
Cfn— Resource properties.Rule Group Props
Construct Props
| Name | Type | Description |
|---|---|---|
| capacity | number | The web ACL capacity units (WCUs) required for this rule group. |
| scope | string | Specifies whether this is for an Amazon CloudFront distribution or for a regional application. |
| visibility | IResolvable | Visibility | Defines and enables Amazon CloudWatch metrics and web request sample collection. |
| available | IResolvable | IResolvable | Label[] | The labels that one or more rules in this rule group add to matching web requests. |
| consumed | IResolvable | IResolvable | Label[] | The labels that one or more rules in this rule group match against in label match statements. |
| custom | IResolvable | { [string]: IResolvable | Custom } | A map of custom response keys and content bodies. |
| description? | string | A description of the rule group that helps with identification. |
| name? | string | The name of the rule group. |
| rules? | IResolvable | IResolvable | Rule[] | The rule statements used to identify the web requests that you want to allow, block, or count. |
| tags? | Cfn[] | Key:value pairs associated with an AWS resource. |
capacity
Type:
number
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
scope
Type:
string
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .
For
CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1.
visibilityConfig
Type:
IResolvable | Visibility
Defines and enables Amazon CloudWatch metrics and web request sample collection.
availableLabels?
Type:
IResolvable | IResolvable | Label[]
(optional)
The labels that one or more rules in this rule group add to matching web requests.
These labels are defined in the RuleLabels for a Rule .
consumedLabels?
Type:
IResolvable | IResolvable | Label[]
(optional)
The labels that one or more rules in this rule group match against in label match statements.
These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
customResponseBodies?
Type:
IResolvable | { [string]: IResolvable | Custom }
(optional)
A map of custom response keys and content bodies.
When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
description?
Type:
string
(optional)
A description of the rule group that helps with identification.
name?
Type:
string
(optional)
The name of the rule group.
You cannot change the name of a rule group after you create it.
rules?
Type:
IResolvable | IResolvable | Rule[]
(optional)
The rule statements used to identify the web requests that you want to allow, block, or count.
Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
tags?
Type:
Cfn[]
(optional)
Key:value pairs associated with an AWS resource.
The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
Properties
| Name | Type | Description |
|---|---|---|
| attr | string | The Amazon Resource Name (ARN) of the rule group. |
| attr | string | The ID of the rule group. |
| attr | string | The label namespace prefix for this rule group. |
| capacity | number | The web ACL capacity units (WCUs) required for this rule group. |
| cfn | ICfn | Options for this resource, such as condition, update policy etc. |
| cfn | { [string]: any } | |
| cfn | string | AWS resource type. |
| creation | string[] | |
| logical | string | The logical ID for this CloudFormation stack element. |
| node | Node | The tree node. |
| ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
| scope | string | Specifies whether this is for an Amazon CloudFront distribution or for a regional application. |
| stack | Stack | The stack in which this element is defined. |
| tags | Tag | Tag Manager which manages the tags for this resource. |
| visibility | IResolvable | Visibility | Defines and enables Amazon CloudWatch metrics and web request sample collection. |
| available | IResolvable | IResolvable | Label[] | The labels that one or more rules in this rule group add to matching web requests. |
| consumed | IResolvable | IResolvable | Label[] | The labels that one or more rules in this rule group match against in label match statements. |
| custom | IResolvable | { [string]: IResolvable | Custom } | A map of custom response keys and content bodies. |
| description? | string | A description of the rule group that helps with identification. |
| name? | string | The name of the rule group. |
| rules? | IResolvable | IResolvable | Rule[] | The rule statements used to identify the web requests that you want to allow, block, or count. |
| tags | Cfn[] | Key:value pairs associated with an AWS resource. |
| static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) of the rule group.
attrId
Type:
string
The ID of the rule group.
attrLabelNamespace
Type:
string
The label namespace prefix for this rule group.
All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a rule group is the following: awswaf:<account ID>:rule group:<rule group name>:
When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon.
capacity
Type:
number
The web ACL capacity units (WCUs) required for this rule group.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
scope
Type:
string
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
visibilityConfig
Type:
IResolvable | Visibility
Defines and enables Amazon CloudWatch metrics and web request sample collection.
availableLabels?
Type:
IResolvable | IResolvable | Label[]
(optional)
The labels that one or more rules in this rule group add to matching web requests.
consumedLabels?
Type:
IResolvable | IResolvable | Label[]
(optional)
The labels that one or more rules in this rule group match against in label match statements.
customResponseBodies?
Type:
IResolvable | { [string]: IResolvable | Custom }
(optional)
A map of custom response keys and content bodies.
description?
Type:
string
(optional)
A description of the rule group that helps with identification.
name?
Type:
string
(optional)
The name of the rule group.
rules?
Type:
IResolvable | IResolvable | Rule[]
(optional)
The rule statements used to identify the web requests that you want to allow, block, or count.
tagsRaw?
Type:
Cfn[]
(optional)
Key:value pairs associated with an AWS resource.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
| Name | Description |
|---|---|
| add | Syntactic sugar for addOverride(path, undefined). |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
| add | Add a value to the CloudFormation Resource Metadata. |
| add | Adds an override to the synthesized CloudFormation resource. |
| add | Adds an override that deletes the value of a property from the resource definition. |
| add | Adds an override to a resource property. |
| apply | Sets the deletion policy of the resource based on the removal policy specified. |
| get | Returns a token for an runtime attribute of this resource. |
| get | Retrieve a value value from the CloudFormation Resource Metadata. |
| inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
| obtain | Retrieves an array of resources this resource depends on. |
| obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
| override | Overrides the auto-generated logical ID with a specific ID. |
| remove | Indicates that this resource no longer depends on another resource. |
| replace | Replaces one dependency with another. |
| to | Returns a string representation of this construct. |
| protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined).
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
CfnResource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string - value
any
Add a value to the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string— - The path of the property, you can use dot notation to override values in complex types. - value
any— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
\ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string— The path of the property. - value
any— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
RemovalPolicy - options
RemovalPolicy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string— The name of the attribute. - typeHint
ResolutionType Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack|CfnResource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
CfnResource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn— The dependency to replace.Resource - newTarget
Cfn— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }