Interface ICfnAssociationProps
Properties for defining a CfnAssociation.
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAssociationPropsSyntax (vb)
Public Interface ICfnAssociationPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SSM;
var parameters;
var cfnAssociationProps = new CfnAssociationProps {
Name = "name",
// the properties below are optional
ApplyOnlyAtCronInterval = false,
AssociationName = "associationName",
AutomationTargetParameterName = "automationTargetParameterName",
CalendarNames = new [] { "calendarNames" },
ComplianceSeverity = "complianceSeverity",
DocumentVersion = "documentVersion",
InstanceId = "instanceId",
MaxConcurrency = "maxConcurrency",
MaxErrors = "maxErrors",
OutputLocation = new InstanceAssociationOutputLocationProperty {
S3Location = new S3OutputLocationProperty {
OutputS3BucketName = "outputS3BucketName",
OutputS3KeyPrefix = "outputS3KeyPrefix",
OutputS3Region = "outputS3Region"
}
},
Parameters = parameters,
ScheduleExpression = "scheduleExpression",
ScheduleOffset = 123,
SyncCompliance = "syncCompliance",
Targets = new [] { new TargetProperty {
Key = "key",
Values = new [] { "values" }
} },
WaitForSuccessTimeoutSeconds = 123
};Synopsis
Properties
| 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. |
| AssociationName | Specify a descriptive name for the association. |
| AutomationTargetParameterName | Choose the parameter that will define how your automation will branch out. |
| CalendarNames | The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. |
| ComplianceSeverity | The severity level that is assigned to the association. |
| DocumentVersion | The version of the SSM document to associate with the target. |
| InstanceId |
|
| MaxConcurrency | The maximum number of targets allowed to run the association at the same time. |
| MaxErrors | The number of errors that are allowed before the system stops sending requests to run the association on additional targets. |
| Name | The name of the SSM document that contains the configuration information for the instance. |
| OutputLocation | An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request. |
| Parameters | The parameters for the runtime configuration of the document. |
| ScheduleExpression | A cron expression that specifies a schedule when the association runs. |
| ScheduleOffset | Number of days to wait after the scheduled day to run an association. |
| SyncCompliance | The mode for generating association compliance. |
| Targets | The targets for the association. |
| WaitForSuccessTimeoutSeconds | The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution. |
Properties
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.
object? ApplyOnlyAtCronInterval { get; }Property Value
Remarks
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.
Type union: either bool or IResolvable
AssociationName
Specify a descriptive name for the association.
string? AssociationName { get; }Property Value
Remarks
AutomationTargetParameterName
Choose the parameter that will define how your automation will branch out.
string? AutomationTargetParameterName { get; }Property Value
Remarks
This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in AWS Systems Manager .
CalendarNames
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
string[]? CalendarNames { get; }Property Value
string[]
Remarks
The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide .
ComplianceSeverity
The severity level that is assigned to the association.
string? ComplianceSeverity { get; }Property Value
Remarks
DocumentVersion
The version of the SSM document to associate with the target.
string? DocumentVersion { get; }Property Value
Remarks
Note the following important information.
InstanceId
InstanceIdhas been deprecated.
string? InstanceId { get; }Property Value
Remarks
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.
Note that in some examples later in this page, <code>InstanceIds</code> is used as the tag-key name in a <code>Targets</code> filter. <code>InstanceId</code> is not used as a parameter.
The ID of the instance that the SSM document is associated with. You must specify the InstanceId or Targets property.
MaxConcurrency
The maximum number of targets allowed to run the association at the same time.
string? MaxConcurrency { get; }Property Value
Remarks
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 .
MaxErrors
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
string? MaxErrors { get; }Property Value
Remarks
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.
Name
The name of the SSM document that contains the configuration information for the instance.
object Name { get; }Property Value
Remarks
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 .
Type union: either string or IDocumentRef
OutputLocation
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
object? OutputLocation { get; }Property Value
Remarks
Parameters
The parameters for the runtime configuration of the document.
object? Parameters { get; }Property Value
Remarks
ScheduleExpression
A cron expression that specifies a schedule when the association runs.
string? ScheduleExpression { get; }Property Value
Remarks
The schedule runs in Coordinated Universal Time (UTC).
ScheduleOffset
Number of days to wait after the scheduled day to run an association.
double? ScheduleOffset { get; }Property Value
Remarks
SyncCompliance
The mode for generating association compliance.
string? SyncCompliance { get; }Property Value
Remarks
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.
Targets
The targets for the association.
object? Targets { get; }Property Value
Remarks
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.
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.
Type union: either IResolvable or (either IResolvable or CfnAssociation.ITargetProperty)[]
WaitForSuccessTimeoutSeconds
The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
double? WaitForSuccessTimeoutSeconds { get; }Property Value
Remarks
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 <code>WaitForSuccessTimeoutSeconds</code> , <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">drift detection</a> for your CloudFormation stack’s configuration might yield inaccurate results. If drift detection is important in your scenario, we recommend that you don’t include <code>WaitForSuccessTimeoutSeconds</code> in your template.