Show / Hide Table of Contents

Class CfnAssociation

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAssociation
Implements
IInspectable
IAssociationRef
IConstruct
IDependable
IEnvironmentAware
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.SSM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAssociation : CfnResource, IInspectable, IAssociationRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnAssociation Inherits CfnResource Implements IInspectable, IAssociationRef, IConstruct, IDependable, IEnvironmentAware
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 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(Construct, string, ICfnAssociationProps)

Create a new AWS::SSM::Association.

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.

AssociationRef

A reference to a Association resource.

AttrAssociationId

The association ID.

AutomationTargetParameterName

Choose the parameter that will define how your automation will branch out.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CalendarNames

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.

CfnProperties

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

ComplianceSeverity

The severity level that is assigned to the association.

DocumentVersion

The version of the SSM document to associate with the target.

InstanceId

InstanceId has been deprecated.

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

ArnForAssociation(IAssociationRef)

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

FromAssociationId(Construct, string, string)

Creates a new IAssociationRef from a associationId.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnAssociation(object)

Checks whether the given object is a CfnAssociation.

RenderProperties(IDictionary<string, object>)

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

Constructors

CfnAssociation(Construct, string, ICfnAssociationProps)

Create a new AWS::SSM::Association.

public CfnAssociation(Construct scope, string id, ICfnAssociationProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAssociationProps

Resource properties.

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

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

object

Remarks

Type union: either bool or IResolvable

AssociationName

Specify a descriptive name for the association.

public virtual string? AssociationName { get; set; }
Property Value

string

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

AssociationRef

A reference to a Association resource.

public virtual IAssociationReference AssociationRef { get; }
Property Value

IAssociationReference

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

AttrAssociationId

The association ID.

public virtual string AttrAssociationId { get; }
Property Value

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

string

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

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

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

string[]

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

CfnProperties

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
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 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

ComplianceSeverity

The severity level that is assigned to the association.

public virtual string? ComplianceSeverity { get; set; }
Property Value

string

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

DocumentVersion

The version of the SSM document to associate with the target.

public virtual string? DocumentVersion { get; set; }
Property Value

string

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

InstanceId

InstanceId has been deprecated.

public virtual string? InstanceId { get; set; }
Property Value

string

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

MaxConcurrency

The maximum number of targets allowed to run the association at the same time.

public virtual string? MaxConcurrency { get; set; }
Property Value

string

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

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

string

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

Name

The name of the SSM document that contains the configuration information for the instance.

public virtual string Name { get; set; }
Property Value

string

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

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

object

Remarks

Type union: either IResolvable or CfnAssociation.IInstanceAssociationOutputLocationProperty

Parameters

The parameters for the runtime configuration of the document.

public virtual object? Parameters { get; set; }
Property Value

object

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

ScheduleExpression

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

public virtual string? ScheduleExpression { get; set; }
Property Value

string

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

ScheduleOffset

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

public virtual double? ScheduleOffset { get; set; }
Property Value

double?

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

SyncCompliance

The mode for generating association compliance.

public virtual string? SyncCompliance { get; set; }
Property Value

string

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

Targets

The targets for the association.

public virtual object? Targets { get; set; }
Property Value

object

Remarks

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.

public virtual double? WaitForSuccessTimeoutSeconds { get; set; }
Property Value

double?

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

Methods

ArnForAssociation(IAssociationRef)

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

public static string ArnForAssociation(IAssociationRef resource)
Parameters
resource IAssociationRef
Returns

string

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 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
             });

FromAssociationId(Construct, string, string)

Creates a new IAssociationRef from a associationId.

public static IAssociationRef FromAssociationId(Construct scope, string id, string associationId)
Parameters
scope Construct
id string
associationId string
Returns

IAssociationRef

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

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.

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

IsCfnAssociation(object)

Checks whether the given object is a CfnAssociation.

public static bool IsCfnAssociation(object x)
Parameters
x object
Returns

bool

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

RenderProperties(IDictionary<string, object>)

The AWS::SSM::Association resource creates a State Manager association for your managed instances.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
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 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

Implements

IInspectable
IAssociationRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
Back to top Generated by DocFX