Package software.amazon.awscdk.services.ssm

Class CfnAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ssm.CfnAssociation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.727Z") @Stability(Stable) public class CfnAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::SSM::Association.

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 AWS 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.services.ssm.*;
 Object parameters;
 CfnAssociation cfnAssociation = CfnAssociation.Builder.create(this, "MyCfnAssociation")
         .name("name")
         // the properties below are optional
         .applyOnlyAtCronInterval(false)
         .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")
         .targets(List.of(TargetProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .waitForSuccessTimeoutSeconds(123)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAssociation

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

    • CfnAssociation

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

    • CfnAssociation

      @Stability(Stable) public CfnAssociation(@NotNull Construct scope, @NotNull String id, @NotNull CfnAssociationProps props)
      Create a new AWS::SSM::Association.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAssociationId

      @Stability(Stable) @NotNull public String getAttrAssociationId()
      The association ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the SSM document that contains the configuration information for the instance.

      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 .

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the SSM document that contains the configuration information for the instance.

      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 .

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      The parameters for the runtime configuration of the document.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      The parameters for the runtime configuration of the document.

    • getApplyOnlyAtCronInterval

      @Stability(Stable) @Nullable public Object getApplyOnlyAtCronInterval()
      By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.

      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.

    • setApplyOnlyAtCronInterval

      @Stability(Stable) public void setApplyOnlyAtCronInterval(@Nullable Boolean value)
      By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.

      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.

    • setApplyOnlyAtCronInterval

      @Stability(Stable) public void setApplyOnlyAtCronInterval(@Nullable IResolvable value)
      By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified.

      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.

    • getAssociationName

      @Stability(Stable) @Nullable public String getAssociationName()
      Specify a descriptive name for the association.

    • setAssociationName

      @Stability(Stable) public void setAssociationName(@Nullable String value)
      Specify a descriptive name for the association.

    • getAutomationTargetParameterName

      @Stability(Stable) @Nullable public String getAutomationTargetParameterName()
      Choose the parameter that will define how your automation will branch out.

      This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .

    • setAutomationTargetParameterName

      @Stability(Stable) public void setAutomationTargetParameterName(@Nullable String value)
      Choose the parameter that will define how your automation will branch out.

      This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager .

    • getCalendarNames

      @Stability(Stable) @Nullable public List<String> getCalendarNames()
      The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.

      The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar .

    • setCalendarNames

      @Stability(Stable) public void setCalendarNames(@Nullable List<String> value)
      The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.

      The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar .

    • getComplianceSeverity

      @Stability(Stable) @Nullable public String getComplianceSeverity()
      The severity level that is assigned to the association.

    • setComplianceSeverity

      @Stability(Stable) public void setComplianceSeverity(@Nullable String value)
      The severity level that is assigned to the association.

    • getDocumentVersion

      @Stability(Stable) @Nullable public String getDocumentVersion()
      The version of the SSM document to associate with the target.

      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 default version 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 to default .
      • DocumentVersion is not valid for documents owned by AWS , such as AWS-RunPatchBaseline or AWS-UpdateSSMAgent . If you specify DocumentVersion for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).

    • setDocumentVersion

      @Stability(Stable) public void setDocumentVersion(@Nullable String value)
      The version of the SSM document to associate with the target.

      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 default version 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 to default .
      • DocumentVersion is not valid for documents owned by AWS , such as AWS-RunPatchBaseline or AWS-UpdateSSMAgent . If you specify DocumentVersion for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken: , HandlerErrorCode: GeneralServiceException).

    • getInstanceId

      @Stability(Stable) @Nullable public String getInstanceId()
      The ID of the instance that the SSM document is associated with.

      You must specify the InstanceId or Targets property.

      InstanceId has been deprecated. 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.

    • setInstanceId

      @Stability(Stable) public void setInstanceId(@Nullable String value)
      The ID of the instance that the SSM document is associated with.

      You must specify the InstanceId or Targets property.

      InstanceId has been deprecated. 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.

    • getMaxConcurrency

      @Stability(Stable) @Nullable public String getMaxConcurrency()
      The maximum number of targets allowed to run the association at the same time.

      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 .

    • setMaxConcurrency

      @Stability(Stable) public void setMaxConcurrency(@Nullable String value)
      The maximum number of targets allowed to run the association at the same time.

      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 .

    • getMaxErrors

      @Stability(Stable) @Nullable public String getMaxErrors()
      The number of errors that are allowed before the system stops sending requests to run the association on additional targets.

      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.

    • setMaxErrors

      @Stability(Stable) public void setMaxErrors(@Nullable String value)
      The number of errors that are allowed before the system stops sending requests to run the association on additional targets.

      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.

    • getOutputLocation

      @Stability(Stable) @Nullable public Object getOutputLocation()
      An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

    • setOutputLocation

      @Stability(Stable) public void setOutputLocation(@Nullable IResolvable value)
      An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

    • setOutputLocation

      @Stability(Stable) public void setOutputLocation(@Nullable CfnAssociation.InstanceAssociationOutputLocationProperty value)
      An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

    • getScheduleExpression

      @Stability(Stable) @Nullable public String getScheduleExpression()
      A cron expression that specifies a schedule when the association runs.

      The schedule runs in Coordinated Universal Time (UTC).

    • setScheduleExpression

      @Stability(Stable) public void setScheduleExpression(@Nullable String value)
      A cron expression that specifies a schedule when the association runs.

      The schedule runs in Coordinated Universal Time (UTC).

    • getScheduleOffset

      @Stability(Stable) @Nullable public Number getScheduleOffset()
      Number of days to wait after the scheduled day to run an association.

    • setScheduleOffset

      @Stability(Stable) public void setScheduleOffset(@Nullable Number value)
      Number of days to wait after the scheduled day to run an association.

    • getSyncCompliance

      @Stability(Stable) @Nullable public String getSyncCompliance()
      The mode for generating association compliance.

      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.

    • setSyncCompliance

      @Stability(Stable) public void setSyncCompliance(@Nullable String value)
      The mode for generating association compliance.

      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.

    • getTargets

      @Stability(Stable) @Nullable public Object getTargets()
      The targets for the association.

      You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . 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.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable IResolvable value)
      The targets for the association.

      You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . 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.

    • setTargets

      @Stability(Stable) public void setTargets(@Nullable List<Object> value)
      The targets for the association.

      You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying the InstanceIds key with a value of * . 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.

    • getWaitForSuccessTimeoutSeconds

      @Stability(Stable) @Nullable public Number getWaitForSuccessTimeoutSeconds()
      The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.

      If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.

    • setWaitForSuccessTimeoutSeconds

      @Stability(Stable) public void setWaitForSuccessTimeoutSeconds(@Nullable Number value)
      The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.

      If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.