Package software.amazon.awscdk.services.ssm

Class CfnAssociationProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ssm.CfnAssociationProps.Jsii$Proxy

All Implemented Interfaces:

CfnAssociationProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAssociationProps

@Stability(Stable)
@Internal
public static final class CfnAssociationProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAssociationProps

An implementation for CfnAssociationProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.CfnAssociationProps

CfnAssociationProps.Builder, CfnAssociationProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAssociationProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAssociationProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final 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.
final String	getAssociationName()	Specify a descriptive name for the association.
final String	getAutomationTargetParameterName()	Choose the parameter that will define how your automation will branch out.
final List<String>	getCalendarNames()	The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
final String	getComplianceSeverity()	The severity level that is assigned to the association.
final String	getDocumentVersion()	The version of the SSM document to associate with the target.
final String	getInstanceId()	The ID of the instance that the SSM document is associated with.
final String	getMaxConcurrency()	The maximum number of targets allowed to run the association at the same time.
final String	getMaxErrors()	The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
final String	getName()	The name of the SSM document that contains the configuration information for the instance.
final Object	getOutputLocation()	An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
final Object	getParameters()	The parameters for the runtime configuration of the document.
final String	getScheduleExpression()	A cron expression that specifies a schedule when the association runs.
final Number	getScheduleOffset()	Number of days to wait after the scheduled day to run an association.
final String	getSyncCompliance()	The mode for generating association compliance.
final Object	getTargets()	The targets for the association.
final Number	getWaitForSuccessTimeoutSeconds()	The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAssociationProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAssociationProps.Builder.

Method Details

getName

public final String getName()

Description copied from interface: CfnAssociationProps

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 .

Specified by:

getName in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name

getApplyOnlyAtCronInterval

public final Object getApplyOnlyAtCronInterval()

Description copied from interface: CfnAssociationProps

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.

Specified by:

getApplyOnlyAtCronInterval in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-applyonlyatcroninterval

getAssociationName

public final String getAssociationName()

Description copied from interface: CfnAssociationProps

Specify a descriptive name for the association.

Specified by:

getAssociationName in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname

getAutomationTargetParameterName

public final String getAutomationTargetParameterName()

Description copied from interface: CfnAssociationProps

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 .

Specified by:

getAutomationTargetParameterName in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-automationtargetparametername

getCalendarNames

public final List<String> getCalendarNames()

Description copied from interface: CfnAssociationProps

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 .

Specified by:

getCalendarNames in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-calendarnames

getComplianceSeverity

public final String getComplianceSeverity()

Description copied from interface: CfnAssociationProps

The severity level that is assigned to the association.

Specified by:

getComplianceSeverity in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-complianceseverity

getDocumentVersion

public final String getDocumentVersion()

Description copied from interface: CfnAssociationProps

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

Specified by:

getDocumentVersion in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion

getInstanceId

public final String getInstanceId()

Description copied from interface: CfnAssociationProps

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.

Specified by:

getInstanceId in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid

getMaxConcurrency

public final String getMaxConcurrency()

Description copied from interface: CfnAssociationProps

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 .

Specified by:

getMaxConcurrency in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxconcurrency

getMaxErrors

public final String getMaxErrors()

Description copied from interface: CfnAssociationProps

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.

Specified by:

getMaxErrors in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-maxerrors

getOutputLocation

public final Object getOutputLocation()

Description copied from interface: CfnAssociationProps

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

Specified by:

getOutputLocation in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation

getParameters

public final Object getParameters()

Description copied from interface: CfnAssociationProps

The parameters for the runtime configuration of the document.

Specified by:

getParameters in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters

getScheduleExpression

public final String getScheduleExpression()

Description copied from interface: CfnAssociationProps

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

The schedule runs in Coordinated Universal Time (UTC).

Specified by:

getScheduleExpression in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression

getScheduleOffset

public final Number getScheduleOffset()

Description copied from interface: CfnAssociationProps

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

Specified by:

getScheduleOffset in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleoffset

getSyncCompliance

public final String getSyncCompliance()

Description copied from interface: CfnAssociationProps

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.

Specified by:

getSyncCompliance in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-synccompliance

getTargets

public final Object getTargets()

Description copied from interface: CfnAssociationProps

The targets for the association.

You must specify the InstanceId or Targets property. You can target all instances in an AWS account by specifying t he InstanceIds 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.

Specified by:

getTargets in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets

getWaitForSuccessTimeoutSeconds

public final Number getWaitForSuccessTimeoutSeconds()

Description copied from interface: CfnAssociationProps

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 include WaitForSuccessTimeoutSeconds in your template.

Specified by:

getWaitForSuccessTimeoutSeconds in interface CfnAssociationProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-waitforsuccesstimeoutseconds

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object