software.amazon.awscdk.services.ssm

Class CfnAssociation.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnAssociation.Builder

Enclosing class:

CfnAssociation

public static final class CfnAssociation.Builder
extends java.lang.Object

A fluent builder for CfnAssociation.

Method Summary

Modifier and Type	Method and Description
CfnAssociation.Builder	applyOnlyAtCronInterval(java.lang.Boolean applyOnlyAtCronInterval) 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.
CfnAssociation.Builder	applyOnlyAtCronInterval(IResolvable applyOnlyAtCronInterval) 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.
CfnAssociation.Builder	associationName(java.lang.String associationName) Specify a descriptive name for the association.
CfnAssociation.Builder	automationTargetParameterName(java.lang.String automationTargetParameterName) Choose the parameter that will define how your automation will branch out.
CfnAssociation	build()
CfnAssociation.Builder	calendarNames(java.util.List<java.lang.String> calendarNames) The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
CfnAssociation.Builder	complianceSeverity(java.lang.String complianceSeverity) The severity level that is assigned to the association.
static CfnAssociation.Builder	create(Construct scope, java.lang.String id)
CfnAssociation.Builder	documentVersion(java.lang.String documentVersion) The version of the SSM document to associate with the target.
CfnAssociation.Builder	instanceId(java.lang.String instanceId) The ID of the instance that the SSM document is associated with.
CfnAssociation.Builder	maxConcurrency(java.lang.String maxConcurrency) The maximum number of targets allowed to run the association at the same time.
CfnAssociation.Builder	maxErrors(java.lang.String maxErrors) The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
CfnAssociation.Builder	name(java.lang.String name) The name of the SSM document that contains the configuration information for the instance.
CfnAssociation.Builder	outputLocation(CfnAssociation.InstanceAssociationOutputLocationProperty outputLocation) An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
CfnAssociation.Builder	outputLocation(IResolvable outputLocation) An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
CfnAssociation.Builder	parameters(java.lang.Object parameters) The parameters for the runtime configuration of the document.
CfnAssociation.Builder	scheduleExpression(java.lang.String scheduleExpression) A cron expression that specifies a schedule when the association runs.
CfnAssociation.Builder	scheduleOffset(java.lang.Number scheduleOffset) Number of days to wait after the scheduled day to run an association.
CfnAssociation.Builder	syncCompliance(java.lang.String syncCompliance) The mode for generating association compliance.
CfnAssociation.Builder	targets(IResolvable targets) The targets for the association.
CfnAssociation.Builder	targets(java.util.List<? extends java.lang.Object> targets) The targets for the association.
CfnAssociation.Builder	waitForSuccessTimeoutSeconds(java.lang.Number waitForSuccessTimeoutSeconds) The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnAssociation.Builder create(Construct scope,
                                            java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnAssociation.InstanceAssociationOutputLocationProperty.Builder.

name

public CfnAssociation.Builder name(java.lang.String name)

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 .

Parameters:

name - The name of the SSM document that contains the configuration information for the instance. This parameter is required.

Returns:

this

applyOnlyAtCronInterval

public CfnAssociation.Builder applyOnlyAtCronInterval(java.lang.Boolean applyOnlyAtCronInterval)

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.

Parameters:

applyOnlyAtCronInterval - 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. This parameter is required.

Returns:

this

applyOnlyAtCronInterval

public CfnAssociation.Builder applyOnlyAtCronInterval(IResolvable applyOnlyAtCronInterval)

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.

Parameters:

applyOnlyAtCronInterval - 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. This parameter is required.

Returns:

this

associationName

public CfnAssociation.Builder associationName(java.lang.String associationName)

Specify a descriptive name for the association.

Parameters:

associationName - Specify a descriptive name for the association. This parameter is required.

Returns:

this

automationTargetParameterName

public CfnAssociation.Builder automationTargetParameterName(java.lang.String automationTargetParameterName)

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 .

Parameters:

automationTargetParameterName - Choose the parameter that will define how your automation will branch out. This parameter is required.

Returns:

this

calendarNames

public CfnAssociation.Builder calendarNames(java.util.List<java.lang.String> calendarNames)

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 .

Parameters:

calendarNames - The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. This parameter is required.

Returns:

this

complianceSeverity

public CfnAssociation.Builder complianceSeverity(java.lang.String complianceSeverity)

The severity level that is assigned to the association.

Parameters:

complianceSeverity - The severity level that is assigned to the association. This parameter is required.

Returns:

this

documentVersion

public CfnAssociation.Builder documentVersion(java.lang.String documentVersion)

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).

Parameters:

documentVersion - The version of the SSM document to associate with the target. This parameter is required.

Returns:

this

instanceId

public CfnAssociation.Builder instanceId(java.lang.String instanceId)

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.

Parameters:

instanceId - The ID of the instance that the SSM document is associated with. This parameter is required.

Returns:

this

maxConcurrency

public CfnAssociation.Builder maxConcurrency(java.lang.String maxConcurrency)

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 .

Parameters:

maxConcurrency - The maximum number of targets allowed to run the association at the same time. This parameter is required.

Returns:

this

maxErrors

public CfnAssociation.Builder maxErrors(java.lang.String maxErrors)

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.

Parameters:

maxErrors - The number of errors that are allowed before the system stops sending requests to run the association on additional targets. This parameter is required.

Returns:

this

outputLocation

public CfnAssociation.Builder outputLocation(IResolvable outputLocation)

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

Parameters:

outputLocation - An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. This parameter is required.

Returns:

this

outputLocation

public CfnAssociation.Builder outputLocation(CfnAssociation.InstanceAssociationOutputLocationProperty outputLocation)

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.

Parameters:

outputLocation - An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. This parameter is required.

Returns:

this

parameters

public CfnAssociation.Builder parameters(java.lang.Object parameters)

The parameters for the runtime configuration of the document.

Parameters:

parameters - The parameters for the runtime configuration of the document. This parameter is required.

Returns:

this

scheduleExpression

public CfnAssociation.Builder scheduleExpression(java.lang.String scheduleExpression)

A cron expression that specifies a schedule when the association runs.

The schedule runs in Coordinated Universal Time (UTC).

Parameters:

scheduleExpression - A cron expression that specifies a schedule when the association runs. This parameter is required.

Returns:

this

scheduleOffset

public CfnAssociation.Builder scheduleOffset(java.lang.Number scheduleOffset)

Number of days to wait after the scheduled day to run an association.

Parameters:

scheduleOffset - Number of days to wait after the scheduled day to run an association. This parameter is required.

Returns:

this

syncCompliance

public CfnAssociation.Builder syncCompliance(java.lang.String syncCompliance)

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.

Parameters:

syncCompliance - The mode for generating association compliance. This parameter is required.

Returns:

this

targets

public CfnAssociation.Builder targets(IResolvable targets)

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.

Parameters:

targets - The targets for the association. This parameter is required.

Returns:

this

targets

public CfnAssociation.Builder targets(java.util.List<? extends java.lang.Object> targets)

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.

Parameters:

targets - The targets for the association. This parameter is required.

Returns:

this

waitForSuccessTimeoutSeconds

public CfnAssociation.Builder waitForSuccessTimeoutSeconds(java.lang.Number waitForSuccessTimeoutSeconds)

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.

Parameters:

waitForSuccessTimeoutSeconds - The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution. This parameter is required.

Returns:

this

build

public CfnAssociation build()