Class CfnAssociation
The AWS::SSM::Association
resource creates a State Manager association for your managed instances.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAssociation : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAssociation
Inherits CfnResource
Implements IInspectable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html
CloudformationResource: AWS::SSM::Association
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 cfnAssociation = new CfnAssociation(this, "MyCfnAssociation", 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
Constructors
CfnAssociation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAssociation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAssociation(Construct, String, ICfnAssociationProps) |
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. |
AttrAssociationId | The association ID. |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ComplianceSeverity | The severity level that is assigned to the association. |
DocumentVersion | The version of the SSM document to associate with the target. |
InstanceId | The ID of the instance that the SSM document is associated with. |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAssociation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAssociation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAssociation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAssociation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAssociation(Construct, String, ICfnAssociationProps)
public CfnAssociation(Construct scope, string id, ICfnAssociationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAssociationProps
Resource properties.
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.
public virtual object ApplyOnlyAtCronInterval { get; set; }
Property Value
System.Object
AssociationName
Specify a descriptive name for the association.
public virtual string AssociationName { get; set; }
Property Value
System.String
AttrAssociationId
The association ID.
public virtual string AttrAssociationId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AssociationId
AutomationTargetParameterName
Choose the parameter that will define how your automation will branch out.
public virtual string AutomationTargetParameterName { get; set; }
Property Value
System.String
CalendarNames
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
public virtual string[] CalendarNames { get; set; }
Property Value
System.String[]
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ComplianceSeverity
The severity level that is assigned to the association.
public virtual string ComplianceSeverity { get; set; }
Property Value
System.String
DocumentVersion
The version of the SSM document to associate with the target.
public virtual string DocumentVersion { get; set; }
Property Value
System.String
InstanceId
The ID of the instance that the SSM document is associated with.
public virtual string InstanceId { get; set; }
Property Value
System.String
MaxConcurrency
The maximum number of targets allowed to run the association at the same time.
public virtual string MaxConcurrency { get; set; }
Property Value
System.String
MaxErrors
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
public virtual string MaxErrors { get; set; }
Property Value
System.String
Name
The name of the SSM document that contains the configuration information for the instance.
public virtual string Name { get; set; }
Property Value
System.String
OutputLocation
An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.
public virtual object OutputLocation { get; set; }
Property Value
System.Object
Parameters
The parameters for the runtime configuration of the document.
public virtual object Parameters { get; set; }
Property Value
System.Object
ScheduleExpression
A cron expression that specifies a schedule when the association runs.
public virtual string ScheduleExpression { get; set; }
Property Value
System.String
ScheduleOffset
Number of days to wait after the scheduled day to run an association.
public virtual Nullable<double> ScheduleOffset { get; set; }
Property Value
System.Nullable<System.Double>
SyncCompliance
The mode for generating association compliance.
public virtual string SyncCompliance { get; set; }
Property Value
System.String
Targets
The targets for the association.
public virtual object Targets { get; set; }
Property Value
System.Object
WaitForSuccessTimeoutSeconds
The number of seconds the service should wait for the association status to show "Success" before proceeding with the stack execution.
public virtual Nullable<double> WaitForSuccessTimeoutSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>