@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:20.881Z") public class CfnAssociation extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnAssociation.Builder
A fluent builder for
CfnAssociation . |
static interface |
CfnAssociation.InstanceAssociationOutputLocationProperty
`InstanceAssociationOutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.
|
static interface |
CfnAssociation.S3OutputLocationProperty
`S3OutputLocation` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies an Amazon S3 bucket where you want to store the results of this association request.
|
static interface |
CfnAssociation.TargetProperty
`Target` is a property of the [AWS::SSM::Association](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html) resource that specifies the targets for an SSM document in Systems Manager .
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAssociation(Construct scope,
java.lang.String id,
CfnAssociationProps props)
Create a new `AWS::SSM::Association`.
|
protected |
CfnAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnAssociation(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.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.
|
java.lang.String |
getAssociationName()
Specify a descriptive name for the association.
|
java.lang.String |
getAttrAssociationId()
The association ID.
|
java.lang.String |
getAutomationTargetParameterName()
Choose the parameter that will define how your automation will branch out.
|
java.util.List<java.lang.String> |
getCalendarNames()
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getComplianceSeverity()
The severity level that is assigned to the association.
|
java.lang.String |
getDocumentVersion()
The version of the SSM document to associate with the target.
|
java.lang.String |
getInstanceId()
The ID of the instance that the SSM document is associated with.
|
java.lang.String |
getMaxConcurrency()
The maximum number of targets allowed to run the association at the same time.
|
java.lang.String |
getMaxErrors()
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
|
java.lang.String |
getName()
The name of the SSM document that contains the configuration information for the instance.
|
java.lang.Object |
getOutputLocation()
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
java.lang.Object |
getParameters()
The parameters for the runtime configuration of the document.
|
java.lang.String |
getScheduleExpression()
A cron expression that specifies a schedule when the association runs.
|
java.lang.Number |
getScheduleOffset()
Number of days to wait after the scheduled day to run an association.
|
java.lang.String |
getSyncCompliance()
The mode for generating association compliance.
|
java.lang.Object |
getTargets()
The targets for the association.
|
java.lang.Number |
getWaitForSuccessTimeoutSeconds()
The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApplyOnlyAtCronInterval(java.lang.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.
|
void |
setApplyOnlyAtCronInterval(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.
|
void |
setAssociationName(java.lang.String value)
Specify a descriptive name for the association.
|
void |
setAutomationTargetParameterName(java.lang.String value)
Choose the parameter that will define how your automation will branch out.
|
void |
setCalendarNames(java.util.List<java.lang.String> value)
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
|
void |
setComplianceSeverity(java.lang.String value)
The severity level that is assigned to the association.
|
void |
setDocumentVersion(java.lang.String value)
The version of the SSM document to associate with the target.
|
void |
setInstanceId(java.lang.String value)
The ID of the instance that the SSM document is associated with.
|
void |
setMaxConcurrency(java.lang.String value)
The maximum number of targets allowed to run the association at the same time.
|
void |
setMaxErrors(java.lang.String value)
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
|
void |
setName(java.lang.String value)
The name of the SSM document that contains the configuration information for the instance.
|
void |
setOutputLocation(CfnAssociation.InstanceAssociationOutputLocationProperty value)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
void |
setOutputLocation(IResolvable value)
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
|
void |
setParameters(java.lang.Object value)
The parameters for the runtime configuration of the document.
|
void |
setScheduleExpression(java.lang.String value)
A cron expression that specifies a schedule when the association runs.
|
void |
setScheduleOffset(java.lang.Number value)
Number of days to wait after the scheduled day to run an association.
|
void |
setSyncCompliance(java.lang.String value)
The mode for generating association compliance.
|
void |
setTargets(IResolvable value)
The targets for the association.
|
void |
setTargets(java.util.List<java.lang.Object> value)
The targets for the association.
|
void |
setWaitForSuccessTimeoutSeconds(java.lang.Number value)
The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAssociation(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAssociation(Construct scope, java.lang.String id, CfnAssociationProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAssociationId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getName()
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
.
public void setName(java.lang.String value)
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
.
public java.lang.Object getParameters()
public void setParameters(java.lang.Object value)
public java.lang.Object getApplyOnlyAtCronInterval()
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.
public void setApplyOnlyAtCronInterval(java.lang.Boolean value)
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.
public void setApplyOnlyAtCronInterval(IResolvable value)
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.
public java.lang.String getAssociationName()
public void setAssociationName(java.lang.String value)
public java.lang.String getAutomationTargetParameterName()
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 .
public void setAutomationTargetParameterName(java.lang.String value)
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 .
public java.util.List<java.lang.String> getCalendarNames()
The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar .
public void setCalendarNames(java.util.List<java.lang.String> value)
The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar .
public java.lang.String getComplianceSeverity()
public void setComplianceSeverity(java.lang.String value)
public java.lang.String getDocumentVersion()
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 todefault
.DocumentVersion
is not valid for documents owned by AWS , such asAWS-RunPatchBaseline
orAWS-UpdateSSMAgent
. If you specifyDocumentVersion
for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken:, HandlerErrorCode: GeneralServiceException).
public void setDocumentVersion(java.lang.String value)
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 todefault
.DocumentVersion
is not valid for documents owned by AWS , such asAWS-RunPatchBaseline
orAWS-UpdateSSMAgent
. If you specifyDocumentVersion
for an AWS document, the system returns the following error: "Error occurred during operation 'CreateAssociation'." (RequestToken:, HandlerErrorCode: GeneralServiceException).
public java.lang.String getInstanceId()
You must specify the InstanceId
or Targets
property.
InstanceId
has been deprecated. To specify an instance ID for an association, use theTargets
parameter. If you use the parameterInstanceId
, you cannot use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.
public void setInstanceId(java.lang.String value)
You must specify the InstanceId
or Targets
property.
InstanceId
has been deprecated. To specify an instance ID for an association, use theTargets
parameter. If you use the parameterInstanceId
, you cannot use the parametersAssociationName
,DocumentVersion
,MaxErrors
,MaxConcurrency
,OutputLocation
, orScheduleExpression
. To use these parameters, you must use theTargets
parameter.
public java.lang.String getMaxConcurrency()
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
.
public void setMaxConcurrency(java.lang.String value)
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
.
public java.lang.String getMaxErrors()
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.
public void setMaxErrors(java.lang.String value)
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.
public java.lang.Object getOutputLocation()
public void setOutputLocation(IResolvable value)
public void setOutputLocation(CfnAssociation.InstanceAssociationOutputLocationProperty value)
public java.lang.String getScheduleExpression()
The schedule runs in Coordinated Universal Time (UTC).
public void setScheduleExpression(java.lang.String value)
The schedule runs in Coordinated Universal Time (UTC).
public java.lang.Number getScheduleOffset()
public void setScheduleOffset(java.lang.Number value)
public java.lang.String getSyncCompliance()
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.
public void setSyncCompliance(java.lang.String value)
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.
public java.lang.Object getTargets()
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.
public void setTargets(IResolvable value)
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.
public void setTargets(java.util.List<java.lang.Object> value)
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.
public java.lang.Number getWaitForSuccessTimeoutSeconds()
If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.
public void setWaitForSuccessTimeoutSeconds(java.lang.Number value)
If the association status doesn't show "Success" after the specified number of seconds, then stack creation fails.