CfnPatchBaseline L1 construct
The AWS::SSM::PatchBaseline resource defines the basic information for an AWS Systems Manager patch baseline.
A patch baseline defines which patches are approved for installation on your instances.
For more information, see CreatePatchBaseline in the AWS Systems Manager API Reference .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const cfnPatchBaseline = new ssm.CfnPatchBaseline(this, 'MyCfnPatchBaseline', {
name: 'name',
// the properties below are optional
approvalRules: {
patchRules: [{
approveAfterDays: 123,
approveUntilDate: 'approveUntilDate',
complianceLevel: 'complianceLevel',
enableNonSecurity: false,
patchFilterGroup: {
patchFilters: [{
key: 'key',
values: ['values'],
}],
},
}],
},
approvedPatches: ['approvedPatches'],
approvedPatchesComplianceLevel: 'approvedPatchesComplianceLevel',
approvedPatchesEnableNonSecurity: false,
availableSecurityUpdatesComplianceStatus: 'availableSecurityUpdatesComplianceStatus',
defaultBaseline: false,
description: 'description',
globalFilters: {
patchFilters: [{
key: 'key',
values: ['values'],
}],
},
operatingSystem: 'operatingSystem',
patchGroups: ['patchGroups'],
rejectedPatches: ['rejectedPatches'],
rejectedPatchesAction: 'rejectedPatchesAction',
sources: [{
configuration: 'configuration',
name: 'name',
products: ['products'],
}],
tags: [{
key: 'key',
value: 'value',
}],
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ssm as ssm
cfn_patch_baseline = ssm.CfnPatchBaseline(self, "MyCfnPatchBaseline",
name="name",
# the properties below are optional
approval_rules=ssm.CfnPatchBaseline.RuleGroupProperty(
patch_rules=[ssm.CfnPatchBaseline.RuleProperty(
approve_after_days=123,
approve_until_date="approveUntilDate",
compliance_level="complianceLevel",
enable_non_security=False,
patch_filter_group=ssm.CfnPatchBaseline.PatchFilterGroupProperty(
patch_filters=[ssm.CfnPatchBaseline.PatchFilterProperty(
key="key",
values=["values"]
)]
)
)]
),
approved_patches=["approvedPatches"],
approved_patches_compliance_level="approvedPatchesComplianceLevel",
approved_patches_enable_non_security=False,
available_security_updates_compliance_status="availableSecurityUpdatesComplianceStatus",
default_baseline=False,
description="description",
global_filters=ssm.CfnPatchBaseline.PatchFilterGroupProperty(
patch_filters=[ssm.CfnPatchBaseline.PatchFilterProperty(
key="key",
values=["values"]
)]
),
operating_system="operatingSystem",
patch_groups=["patchGroups"],
rejected_patches=["rejectedPatches"],
rejected_patches_action="rejectedPatchesAction",
sources=[ssm.CfnPatchBaseline.PatchSourceProperty(
configuration="configuration",
name="name",
products=["products"]
)],
tags=[CfnTag(
key="key",
value="value"
)]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ssm.*;
CfnPatchBaseline cfnPatchBaseline = CfnPatchBaseline.Builder.create(this, "MyCfnPatchBaseline")
.name("name")
// the properties below are optional
.approvalRules(RuleGroupProperty.builder()
.patchRules(List.of(RuleProperty.builder()
.approveAfterDays(123)
.approveUntilDate("approveUntilDate")
.complianceLevel("complianceLevel")
.enableNonSecurity(false)
.patchFilterGroup(PatchFilterGroupProperty.builder()
.patchFilters(List.of(PatchFilterProperty.builder()
.key("key")
.values(List.of("values"))
.build()))
.build())
.build()))
.build())
.approvedPatches(List.of("approvedPatches"))
.approvedPatchesComplianceLevel("approvedPatchesComplianceLevel")
.approvedPatchesEnableNonSecurity(false)
.availableSecurityUpdatesComplianceStatus("availableSecurityUpdatesComplianceStatus")
.defaultBaseline(false)
.description("description")
.globalFilters(PatchFilterGroupProperty.builder()
.patchFilters(List.of(PatchFilterProperty.builder()
.key("key")
.values(List.of("values"))
.build()))
.build())
.operatingSystem("operatingSystem")
.patchGroups(List.of("patchGroups"))
.rejectedPatches(List.of("rejectedPatches"))
.rejectedPatchesAction("rejectedPatchesAction")
.sources(List.of(PatchSourceProperty.builder()
.configuration("configuration")
.name("name")
.products(List.of("products"))
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var cfnPatchBaseline = new CfnPatchBaseline(this, "MyCfnPatchBaseline", new CfnPatchBaselineProps {
Name = "name",
// the properties below are optional
ApprovalRules = new RuleGroupProperty {
PatchRules = new [] { new RuleProperty {
ApproveAfterDays = 123,
ApproveUntilDate = "approveUntilDate",
ComplianceLevel = "complianceLevel",
EnableNonSecurity = false,
PatchFilterGroup = new PatchFilterGroupProperty {
PatchFilters = new [] { new PatchFilterProperty {
Key = "key",
Values = new [] { "values" }
} }
}
} }
},
ApprovedPatches = new [] { "approvedPatches" },
ApprovedPatchesComplianceLevel = "approvedPatchesComplianceLevel",
ApprovedPatchesEnableNonSecurity = false,
AvailableSecurityUpdatesComplianceStatus = "availableSecurityUpdatesComplianceStatus",
DefaultBaseline = false,
Description = "description",
GlobalFilters = new PatchFilterGroupProperty {
PatchFilters = new [] { new PatchFilterProperty {
Key = "key",
Values = new [] { "values" }
} }
},
OperatingSystem = "operatingSystem",
PatchGroups = new [] { "patchGroups" },
RejectedPatches = new [] { "rejectedPatches" },
RejectedPatchesAction = "rejectedPatchesAction",
Sources = new [] { new PatchSourceProperty {
Configuration = "configuration",
Name = "name",
Products = new [] { "products" }
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnPatchBaseline := awscdk.Aws_ssm.NewCfnPatchBaseline(this, jsii.String("MyCfnPatchBaseline"), &CfnPatchBaselineProps{
Name: jsii.String("name"),
// the properties below are optional
ApprovalRules: &RuleGroupProperty{
PatchRules: []interface{}{
&RuleProperty{
ApproveAfterDays: jsii.Number(123),
ApproveUntilDate: jsii.String("approveUntilDate"),
ComplianceLevel: jsii.String("complianceLevel"),
EnableNonSecurity: jsii.Boolean(false),
PatchFilterGroup: &PatchFilterGroupProperty{
PatchFilters: []interface{}{
&PatchFilterProperty{
Key: jsii.String("key"),
Values: []*string{
jsii.String("values"),
},
},
},
},
},
},
},
ApprovedPatches: []*string{
jsii.String("approvedPatches"),
},
ApprovedPatchesComplianceLevel: jsii.String("approvedPatchesComplianceLevel"),
ApprovedPatchesEnableNonSecurity: jsii.Boolean(false),
AvailableSecurityUpdatesComplianceStatus: jsii.String("availableSecurityUpdatesComplianceStatus"),
DefaultBaseline: jsii.Boolean(false),
Description: jsii.String("description"),
GlobalFilters: &PatchFilterGroupProperty{
PatchFilters: []interface{}{
&PatchFilterProperty{
Key: jsii.String("key"),
Values: []*string{
jsii.String("values"),
},
},
},
},
OperatingSystem: jsii.String("operatingSystem"),
PatchGroups: []*string{
jsii.String("patchGroups"),
},
RejectedPatches: []*string{
jsii.String("rejectedPatches"),
},
RejectedPatchesAction: jsii.String("rejectedPatchesAction"),
Sources: []interface{}{
&PatchSourceProperty{
Configuration: jsii.String("configuration"),
Name: jsii.String("name"),
Products: []*string{
jsii.String("products"),
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
Initializer
new CfnPatchBaseline(scope: Construct, id: string, props: CfnPatchBaselineProps)
CfnPatchBaseline(scope: Construct, id: str, props: CfnPatchBaselineProps)
new CfnPatchBaseline(Construct scope, String id, CfnPatchBaselineProps props)
new CfnPatchBaseline(Construct scope, string id, CfnPatchBaselineProps props)
NewCfnPatchBaseline(Scope Construct, Id *string, Props CfnPatchBaselineProps)
Construct Props
approvalRulesoptionalIResolvable | CfnPatchBaseline.RuleGroupPropertyapproval_rulesoptionaltyping.Union[IResolvable, RuleGroupProperty]approvalRulesoptionalIResolvableApprovalRulesoptionalIResolvableApprovalRulesoptionalinterface{}#approvedPatchesoptionalstring[]approved_patchesoptionaltyping.List[str]approvedPatchesoptionalList<String>ApprovedPatchesoptionalstring[]ApprovedPatchesoptional*[]*string#notes
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide .
approvedPatchesComplianceLeveloptionalstringapproved_patches_compliance_leveloptionalstrapprovedPatchesComplianceLeveloptionalStringApprovedPatchesComplianceLeveloptionalstringApprovedPatchesComplianceLeveloptional*string= "UNSPECIFIED"#When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED .
approvedPatchesEnableNonSecurityoptionalboolean | IResolvableapproved_patches_enable_non_securityoptionaltyping.Union[bool, IResolvable]approvedPatchesEnableNonSecurityoptionalBooleanApprovedPatchesEnableNonSecurityoptionalboolApprovedPatchesEnableNonSecurityoptionalinterface{}= false#The default value is false . Applies to Linux managed nodes only.
availableSecurityUpdatesComplianceStatusoptionalstringavailable_security_updates_compliance_statusoptionalstravailableSecurityUpdatesComplianceStatusoptionalStringAvailableSecurityUpdatesComplianceStatusoptionalstringAvailableSecurityUpdatesComplianceStatusoptional*string#notes
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.
Supported for Windows Server managed nodes only.
defaultBaselineoptionalboolean | IResolvabledefault_baselineoptionaltyping.Union[bool, IResolvable]defaultBaselineoptionalBooleanDefaultBaselineoptionalboolDefaultBaselineoptionalinterface{}= false#AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#globalFiltersoptionalIResolvable | CfnPatchBaseline.PatchFilterGroupPropertyglobal_filtersoptionaltyping.Union[IResolvable, PatchFilterGroupProperty]globalFiltersoptionalIResolvableGlobalFiltersoptionalIResolvableGlobalFiltersoptionalinterface{}#The
GlobalFiltersparameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
operatingSystemoptionalstringoperating_systemoptionalstroperatingSystemoptionalStringOperatingSystemoptionalstringOperatingSystemoptional*string= "WINDOWS"#The default value is WINDOWS .
patchGroupsoptionalstring[]patch_groupsoptionaltyping.List[str]patchGroupsoptionalList<String>PatchGroupsoptionalstring[]PatchGroupsoptional*[]*string#rejectedPatchesoptionalstring[]rejected_patchesoptionaltyping.List[str]rejectedPatchesoptionalList<String>RejectedPatchesoptionalstring[]RejectedPatchesoptional*[]*string#notes
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide .
rejectedPatchesActionoptionalstringrejected_patches_actionoptionalstrrejectedPatchesActionoptionalStringRejectedPatchesActionoptionalstringRejectedPatchesActionoptional*string= "ALLOW_AS_DEPENDENCY"#notes
- ALLOW_AS_DEPENDENCY - Linux and macOS : A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as
INSTALLED_OTHER. This is the default action if no option is specified.
Windows Server : Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as INSTALLED_OTHER . Any package not already installed on the node is skipped. This is the default action if no option is specified.
- BLOCK - All OSs : Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.
State value assignment for patch compliance:
- If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as
INSTALLED_REJECTED. - If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as
MISSINGforSCANoperations and asFAILEDforINSTALLoperations.
sourcesoptionalIResolvable | IResolvable | CfnPatchBaseline.PatchSourceProperty[]sourcesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PatchSourceProperty]]]sourcesoptionalIResolvableSourcesoptionalIResolvableSourcesoptionalinterface{}#Applies to Linux managed nodes only.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#notes
Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to.
Properties
approvalRulesmay be undefinedIResolvable | CfnPatchBaseline.RuleGroupPropertyapproval_rulesmay be undefinedtyping.Union[IResolvable, RuleGroupProperty]approvalRulesmay be undefinedIResolvableApprovalRulesmay be undefinedIResolvableApprovalRulesmay be undefinedinterface{}#approvedPatchesmay be undefinedstring[]approved_patchesmay be undefinedtyping.List[str]approvedPatchesmay be undefinedList<String>ApprovedPatchesmay be undefinedstring[]ApprovedPatchesmay be undefined*[]*string#approvedPatchesComplianceLevelmay be undefinedstringapproved_patches_compliance_levelmay be undefinedstrapprovedPatchesComplianceLevelmay be undefinedStringApprovedPatchesComplianceLevelmay be undefinedstringApprovedPatchesComplianceLevelmay be undefined*string#approvedPatchesEnableNonSecuritymay be undefinedboolean | IResolvableapproved_patches_enable_non_securitymay be undefinedtyping.Union[bool, IResolvable]approvedPatchesEnableNonSecuritymay be undefinedBooleanApprovedPatchesEnableNonSecuritymay be undefinedboolApprovedPatchesEnableNonSecuritymay be undefinedinterface{}#availableSecurityUpdatesComplianceStatusmay be undefinedstringavailable_security_updates_compliance_statusmay be undefinedstravailableSecurityUpdatesComplianceStatusmay be undefinedStringAvailableSecurityUpdatesComplianceStatusmay be undefinedstringAvailableSecurityUpdatesComplianceStatusmay be undefined*string#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#defaultBaselinemay be undefinedboolean | IResolvabledefault_baselinemay be undefinedtyping.Union[bool, IResolvable]defaultBaselinemay be undefinedBooleanDefaultBaselinemay be undefinedboolDefaultBaselinemay be undefinedinterface{}#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#globalFiltersmay be undefinedIResolvable | CfnPatchBaseline.PatchFilterGroupPropertyglobal_filtersmay be undefinedtyping.Union[IResolvable, PatchFilterGroupProperty]globalFiltersmay be undefinedIResolvableGlobalFiltersmay be undefinedIResolvableGlobalFiltersmay be undefinedinterface{}#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).
operatingSystemmay be undefinedstringoperating_systemmay be undefinedstroperatingSystemmay be undefinedStringOperatingSystemmay be undefinedstringOperatingSystemmay be undefined*string#patchBaselineRefPatchBaselineReferencepatch_baseline_refPatchBaselineReferencepatchBaselineRefPatchBaselineReferencePatchBaselineRefPatchBaselineReferencePatchBaselineRefPatchBaselineReference#patchGroupsmay be undefinedstring[]patch_groupsmay be undefinedtyping.List[str]patchGroupsmay be undefinedList<String>PatchGroupsmay be undefinedstring[]PatchGroupsmay be undefined*[]*string#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 }).
rejectedPatchesmay be undefinedstring[]rejected_patchesmay be undefinedtyping.List[str]rejectedPatchesmay be undefinedList<String>RejectedPatchesmay be undefinedstring[]RejectedPatchesmay be undefined*[]*string#rejectedPatchesActionmay be undefinedstringrejected_patches_actionmay be undefinedstrrejectedPatchesActionmay be undefinedStringRejectedPatchesActionmay be undefinedstringRejectedPatchesActionmay be undefined*string#sourcesmay be undefinedIResolvable | IResolvable | CfnPatchBaseline.PatchSourceProperty[]sourcesmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PatchSourceProperty]]]sourcesmay be undefinedIResolvableSourcesmay be undefinedIResolvableSourcesmay be undefinedinterface{}#CfnElements must be defined within a stack scope (directly or indirectly).
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
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.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
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:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnPatchBaseline(x: any): boolean@staticmethod def is_cfn_patch_baseline(x: Any) -> boolpublic static Boolean isCfnPatchBaseline(Object x)public static bool IsCfnPatchBaseline(object x)func IsCfnPatchBaseline(X interface{}) *boolstatic#isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.