Interface CfnAssociationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAssociationProps.Jsii$Proxy
CfnAssociation
.
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; CfnAssociationProps cfnAssociationProps = CfnAssociationProps.builder() .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAssociationProps
static final class
An implementation forCfnAssociationProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAssociationProps.Builder
builder()
default Object
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.default String
Specify a descriptive name for the association.default String
Choose the parameter that will define how your automation will branch out.The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.default String
The severity level that is assigned to the association.default String
The version of the SSM document to associate with the target.default String
The ID of the instance that the SSM document is associated with.default String
The maximum number of targets allowed to run the association at the same time.default String
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.getName()
The name of the SSM document that contains the configuration information for the instance.default Object
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.default Object
The parameters for the runtime configuration of the document.default String
A cron expression that specifies a schedule when the association runs.default Number
Number of days to wait after the scheduled day to run an association.default String
The mode for generating association compliance.default Object
The targets for the association.default Number
The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The name of the SSM document that contains the configuration information for the instance.You can specify
Command
orAutomation
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
orMy-Document
.- See Also:
-
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.
- See Also:
-
getAssociationName
Specify a descriptive name for the association.- See Also:
-
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 .
- See Also:
-
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 .
- See Also:
-
getComplianceSeverity
The severity level that is assigned to the association.- See Also:
-
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 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).
- See Also:
- 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
-
getInstanceId
The ID of the instance that the SSM document is associated with.You must specify the
InstanceId
orTargets
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.- See Also:
-
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 forMaxConcurrency
.- See Also:
-
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, setMaxConcurrency
to 1 so that executions proceed one at a time.- See Also:
-
getOutputLocation
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.- See Also:
-
getParameters
The parameters for the runtime configuration of the document.- See Also:
-
getScheduleExpression
A cron expression that specifies a schedule when the association runs.The schedule runs in Coordinated Universal Time (UTC).
- See Also:
-
getScheduleOffset
Number of days to wait after the scheduled day to run an association.- See Also:
-
getSyncCompliance
The mode for generating association compliance.You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
as a parameter for thePutComplianceItems
API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to thePutComplianceItems
API action.By default, all associations use
AUTO
mode.- See Also:
-
getTargets
The targets for the association.You must specify the
InstanceId
orTargets
property. You can target all instances in an AWS account by specifying t heInstanceIds
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.
- See Also:
-
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.
When you specify a value for the
WaitForSuccessTimeoutSeconds
, drift detection for your AWS CloudFormation stack’s configuration might yield inaccurate results. If drift detection is important in your scenario, we recommend that you don’t includeWaitForSuccessTimeoutSeconds
in your template.- See Also:
-
builder
- Returns:
- a
CfnAssociationProps.Builder
ofCfnAssociationProps
-