CfnAssociation L1 construct
The AWS::SSM::Association resource creates a State Manager association for your managed instances.
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Resource Groups or an AWS Auto Scaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
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';
declare const parameters: any;
const cfnAssociation = new ssm.CfnAssociation(this, 'MyCfnAssociation', {
name: 'name',
// the properties below are optional
applyOnlyAtCronInterval: false,
associationDispatchAssumeRole: 'associationDispatchAssumeRole',
associationName: 'associationName',
automationTargetParameterName: 'automationTargetParameterName',
calendarNames: ['calendarNames'],
complianceSeverity: 'complianceSeverity',
documentVersion: 'documentVersion',
instanceId: 'instanceId',
maxConcurrency: 'maxConcurrency',
maxErrors: 'maxErrors',
outputLocation: {
s3Location: {
outputS3BucketName: 'outputS3BucketName',
outputS3KeyPrefix: 'outputS3KeyPrefix',
outputS3Region: 'outputS3Region',
},
},
parameters: parameters,
scheduleExpression: 'scheduleExpression',
scheduleOffset: 123,
syncCompliance: 'syncCompliance',
tags: [{
key: 'key',
value: 'value',
}],
targets: [{
key: 'key',
values: ['values'],
}],
waitForSuccessTimeoutSeconds: 123,
});
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
# parameters: Any
cfn_association = ssm.CfnAssociation(self, "MyCfnAssociation",
name="name",
# the properties below are optional
apply_only_at_cron_interval=False,
association_dispatch_assume_role="associationDispatchAssumeRole",
association_name="associationName",
automation_target_parameter_name="automationTargetParameterName",
calendar_names=["calendarNames"],
compliance_severity="complianceSeverity",
document_version="documentVersion",
instance_id="instanceId",
max_concurrency="maxConcurrency",
max_errors="maxErrors",
output_location=ssm.CfnAssociation.InstanceAssociationOutputLocationProperty(
s3_location=ssm.CfnAssociation.S3OutputLocationProperty(
output_s3_bucket_name="outputS3BucketName",
output_s3_key_prefix="outputS3KeyPrefix",
output_s3_region="outputS3Region"
)
),
parameters=parameters,
schedule_expression="scheduleExpression",
schedule_offset=123,
sync_compliance="syncCompliance",
tags=[CfnTag(
key="key",
value="value"
)],
targets=[ssm.CfnAssociation.TargetProperty(
key="key",
values=["values"]
)],
wait_for_success_timeout_seconds=123
)
// 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.*;
Object parameters;
CfnAssociation cfnAssociation = CfnAssociation.Builder.create(this, "MyCfnAssociation")
.name("name")
// the properties below are optional
.applyOnlyAtCronInterval(false)
.associationDispatchAssumeRole("associationDispatchAssumeRole")
.associationName("associationName")
.automationTargetParameterName("automationTargetParameterName")
.calendarNames(List.of("calendarNames"))
.complianceSeverity("complianceSeverity")
.documentVersion("documentVersion")
.instanceId("instanceId")
.maxConcurrency("maxConcurrency")
.maxErrors("maxErrors")
.outputLocation(InstanceAssociationOutputLocationProperty.builder()
.s3Location(S3OutputLocationProperty.builder()
.outputS3BucketName("outputS3BucketName")
.outputS3KeyPrefix("outputS3KeyPrefix")
.outputS3Region("outputS3Region")
.build())
.build())
.parameters(parameters)
.scheduleExpression("scheduleExpression")
.scheduleOffset(123)
.syncCompliance("syncCompliance")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.targets(List.of(TargetProperty.builder()
.key("key")
.values(List.of("values"))
.build()))
.waitForSuccessTimeoutSeconds(123)
.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 parameters;
var cfnAssociation = new CfnAssociation(this, "MyCfnAssociation", new CfnAssociationProps {
Name = "name",
// the properties below are optional
ApplyOnlyAtCronInterval = false,
AssociationDispatchAssumeRole = "associationDispatchAssumeRole",
AssociationName = "associationName",
AutomationTargetParameterName = "automationTargetParameterName",
CalendarNames = new [] { "calendarNames" },
ComplianceSeverity = "complianceSeverity",
DocumentVersion = "documentVersion",
InstanceId = "instanceId",
MaxConcurrency = "maxConcurrency",
MaxErrors = "maxErrors",
OutputLocation = new InstanceAssociationOutputLocationProperty {
S3Location = new S3OutputLocationProperty {
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
OutputS3Region = "outputS3Region"
}
},
Parameters = parameters,
ScheduleExpression = "scheduleExpression",
ScheduleOffset = 123,
SyncCompliance = "syncCompliance",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Targets = new [] { new TargetProperty {
Key = "key",
Values = new [] { "values" }
} },
WaitForSuccessTimeoutSeconds = 123
});
// 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"
var parameters interface{}
cfnAssociation := awscdk.Aws_ssm.NewCfnAssociation(this, jsii.String("MyCfnAssociation"), &CfnAssociationProps{
Name: jsii.String("name"),
// the properties below are optional
ApplyOnlyAtCronInterval: jsii.Boolean(false),
AssociationDispatchAssumeRole: jsii.String("associationDispatchAssumeRole"),
AssociationName: jsii.String("associationName"),
AutomationTargetParameterName: jsii.String("automationTargetParameterName"),
CalendarNames: []*string{
jsii.String("calendarNames"),
},
ComplianceSeverity: jsii.String("complianceSeverity"),
DocumentVersion: jsii.String("documentVersion"),
InstanceId: jsii.String("instanceId"),
MaxConcurrency: jsii.String("maxConcurrency"),
MaxErrors: jsii.String("maxErrors"),
OutputLocation: &InstanceAssociationOutputLocationProperty{
S3Location: &S3OutputLocationProperty{
OutputS3BucketName: jsii.String("outputS3BucketName"),
OutputS3KeyPrefix: jsii.String("outputS3KeyPrefix"),
OutputS3Region: jsii.String("outputS3Region"),
},
},
Parameters: parameters,
ScheduleExpression: jsii.String("scheduleExpression"),
ScheduleOffset: jsii.Number(123),
SyncCompliance: jsii.String("syncCompliance"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Targets: []interface{}{
&TargetProperty{
Key: jsii.String("key"),
Values: []*string{
jsii.String("values"),
},
},
},
WaitForSuccessTimeoutSeconds: jsii.Number(123),
})
Initializer
new CfnAssociation(scope: Construct, id: string, props: CfnAssociationProps)
CfnAssociation(scope: Construct, id: str, props: CfnAssociationProps)
new CfnAssociation(Construct scope, String id, CfnAssociationProps props)
new CfnAssociation(Construct scope, string id, CfnAssociationProps props)
NewCfnAssociation(Scope Construct, Id *string, Props CfnAssociationProps)
Construct Props
applyOnlyAtCronIntervalboolean | IResolvableapply_only_at_cron_intervaltyping.Union[bool, IResolvable]applyOnlyAtCronIntervalBooleanApplyOnlyAtCronIntervalboolApplyOnlyAtCronIntervalinterface{}#Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
associationDispatchAssumeRolestringassociation_dispatch_assume_rolestrassociationDispatchAssumeRoleStringAssociationDispatchAssumeRolestringAssociationDispatchAssumeRole*string#associationNamestringassociation_namestrassociationNameStringAssociationNamestringAssociationName*string#automationTargetParameterNamestringautomation_target_parameter_namestrautomationTargetParameterNameStringAutomationTargetParameterNamestringAutomationTargetParameterName*string#This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
calendarNamesstring[]calendar_namestyping.List[str]calendarNamesList<String>CalendarNamesstring[]CalendarNames*[]*string#notes
The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide .
complianceSeveritystringcompliance_severitystrcomplianceSeverityStringComplianceSeveritystringComplianceSeverity*string#documentVersionstringdocument_versionstrdocumentVersionStringDocumentVersionstringDocumentVersion*string#notes
Note the following important information.
- State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the
defaultversion of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version todefault.DocumentVersionis not valid for documents owned by AWS , such asAWS-RunPatchBaselineorAWS-UpdateSSMAgent. If you specifyDocumentVersionfor an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: <token>, HandlerErrorCode: GeneralServiceException).
notes
To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId , you cannot use the parameters AssociationName , DocumentVersion , MaxErrors , MaxConcurrency , OutputLocation , or ScheduleExpression . To use these parameters, you must use the Targets parameter.
Note that in some examples later in this page,
InstanceIdsis used as the tag-key name in aTargetsfilter.InstanceIdis not used as a parameter.
The ID of the instance that the SSM document is associated with. You must specify the InstanceId or Targets property.
maxConcurrencystringmax_concurrencystrmaxConcurrencyStringMaxConcurrencystringMaxConcurrency*string#notes
You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency .
notes
You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
namestring | IDocumentRefnametyping.Union[str, IDocumentRef]nameStringNamestringNameinterface{}required#notes
You can specify Command or Automation documents. The documents can be AWS -predefined documents, documents you created, or a document that is shared with you from another account. For SSM documents that are shared with you from other AWS accounts , you must specify the complete SSM document ARN, in the following format:
arn:partition:ssm:region:account-id:document/document-name
For example: arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS -predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS -ApplyPatchBaseline or My-Document .
outputLocationIResolvable | CfnAssociation.InstanceAssociationOutputLocationPropertyoutput_locationtyping.Union[IResolvable, InstanceAssociationOutputLocationProperty]outputLocationIResolvableOutputLocationIResolvableOutputLocationinterface{}#scheduleExpressionstringschedule_expressionstrscheduleExpressionStringScheduleExpressionstringScheduleExpression*string#The schedule runs in Coordinated Universal Time (UTC).
scheduleOffsetnumberschedule_offsetint | floatscheduleOffsetNumberScheduleOffsetdoubleScheduleOffset*float64#syncCompliancestringsync_compliancestrsyncComplianceStringSyncCompliancestringSyncCompliance*string#notes
You can specify AUTO or MANUAL . In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT . If the association execution doesn't run successfully, the association is NON-COMPLIANT .
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
targetsIResolvable | IResolvable | CfnAssociation.TargetProperty[]targetstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetProperty]]]targetsIResolvableTargetsIResolvableTargetsinterface{}#notes
You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying t he InstanceIds key with a value of * .
Supported formats include the following.
Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>
To view a JSON and a YAML example that targets all instances, see "Create an association for all managed instances in an AWS account " on the Examples page.
waitForSuccessTimeoutSecondsnumberwait_for_success_timeout_secondsint | floatwaitForSuccessTimeoutSecondsNumberWaitForSuccessTimeoutSecondsdoubleWaitForSuccessTimeoutSeconds*float64#notes
If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.
When you specify a value for the
WaitForSuccessTimeoutSeconds, drift detection for your CloudFormation stack’s configuration might yield inaccurate results. If drift detection is important in your scenario, we recommend that you don’t includeWaitForSuccessTimeoutSecondsin your template.
Properties
applyOnlyAtCronIntervalboolean | IResolvableapply_only_at_cron_intervaltyping.Union[bool, IResolvable]applyOnlyAtCronIntervalBooleanApplyOnlyAtCronIntervalboolApplyOnlyAtCronIntervalinterface{}#associationDispatchAssumeRolestringassociation_dispatch_assume_rolestrassociationDispatchAssumeRoleStringAssociationDispatchAssumeRolestringAssociationDispatchAssumeRole*string#associationNamestringassociation_namestrassociationNameStringAssociationNamestringAssociationName*string#associationRefAssociationReferenceassociation_refAssociationReferenceassociationRefAssociationReferenceAssociationRefAssociationReferenceAssociationRefAssociationReferencerequired#attrAssociationIdstringattr_association_idstrattrAssociationIdStringAttrAssociationIdstringAttrAssociationId*stringrequired#automationTargetParameterNamestringautomation_target_parameter_namestrautomationTargetParameterNameStringAutomationTargetParameterNamestringAutomationTargetParameterName*string#calendarNamesstring[]calendar_namestyping.List[str]calendarNamesList<String>CalendarNamesstring[]CalendarNames*[]*string#cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManagerrequired#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#complianceSeveritystringcompliance_severitystrcomplianceSeverityStringComplianceSeveritystringComplianceSeverity*string#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#documentVersionstringdocument_versionstrdocumentVersionStringDocumentVersionstringDocumentVersion*string#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).
maxConcurrencystringmax_concurrencystrmaxConcurrencyStringMaxConcurrencystringMaxConcurrency*string#outputLocationIResolvable | CfnAssociation.InstanceAssociationOutputLocationPropertyoutput_locationtyping.Union[IResolvable, InstanceAssociationOutputLocationProperty]outputLocationIResolvableOutputLocationIResolvableOutputLocationinterface{}#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 }).
scheduleExpressionstringschedule_expressionstrscheduleExpressionStringScheduleExpressionstringScheduleExpression*string#scheduleOffsetnumberschedule_offsetint | floatscheduleOffsetNumberScheduleOffsetdoubleScheduleOffset*float64#CfnElements must be defined within a stack scope (directly or indirectly).
syncCompliancestringsync_compliancestrsyncComplianceStringSyncCompliancestringSyncCompliance*string#targetsIResolvable | IResolvable | CfnAssociation.TargetProperty[]targetstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetProperty]]]targetsIResolvableTargetsIResolvableTargetsinterface{}#waitForSuccessTimeoutSecondsnumberwait_for_success_timeout_secondsint | floatwaitForSuccessTimeoutSecondsNumberWaitForSuccessTimeoutSecondsdoubleWaitForSuccessTimeoutSeconds*float64#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:
arnForAssociation(resource: IAssociationRef): string@staticmethod def arn_for_association(resource: IAssociationRef) -> strpublic static String arnForAssociation(IAssociationRef resource)public static string ArnForAssociation(IAssociationRef resource)func ArnForAssociation(Resource IAssociationRef) *stringstatic#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#fromAssociationId(scope: Construct, id: string, associationId: string): IAssociationRef@staticmethod def from_association_id(scope: Construct, id: str, association_id: str) -> IAssociationRefpublic static IAssociationRef fromAssociationId(Construct scope, String id, String associationId)public static IAssociationRef FromAssociationId(Construct scope, string id, string associationId)func FromAssociationId(Scope Construct, Id *string, AssociationId *string) IAssociationRefstatic#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.
isCfnAssociation(x: any): boolean@staticmethod def is_cfn_association(x: Any) -> boolpublic static Boolean isCfnAssociation(Object x)public static bool IsCfnAssociation(object x)func IsCfnAssociation(X interface{}) *boolstatic#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.
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.