Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnAssociationPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnAssociationPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.672Z") @Stability(Stable) public class CfnAssociationPropsMixin extends Mixin implements software.constructs.IMixin
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 software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object parameters;
 CfnAssociationPropsMixin cfnAssociationPropsMixin = CfnAssociationPropsMixin.Builder.create(CfnAssociationMixinProps.builder()
         .applyOnlyAtCronInterval(false)
         .associationName("associationName")
         .automationTargetParameterName("automationTargetParameterName")
         .calendarNames(List.of("calendarNames"))
         .complianceSeverity("complianceSeverity")
         .documentVersion("documentVersion")
         .instanceId("instanceId")
         .maxConcurrency("maxConcurrency")
         .maxErrors("maxErrors")
         .name("name")
         .outputLocation(InstanceAssociationOutputLocationProperty.builder()
                 .s3Location(S3OutputLocationProperty.builder()
                         .outputS3BucketName("outputS3BucketName")
                         .outputS3KeyPrefix("outputS3KeyPrefix")
                         .outputS3Region("outputS3Region")
                         .build())
                 .build())
         .parameters(parameters)
         .scheduleExpression("scheduleExpression")
         .scheduleOffset(123)
         .syncCompliance("syncCompliance")
         .targets(List.of(TargetProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .waitForSuccessTimeoutSeconds(123)
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnAssociationPropsMixin

      protected CfnAssociationPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAssociationPropsMixin

      protected CfnAssociationPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAssociationPropsMixin

      @Stability(Stable) public CfnAssociationPropsMixin(@NotNull CfnAssociationMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SSM::Association.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnAssociationPropsMixin

      @Stability(Stable) public CfnAssociationPropsMixin(@NotNull CfnAssociationMixinProps props)
      Create a mixin to apply properties to AWS::SSM::Association.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnAssociationMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()