Documentation AWS CloudFormation Template Reference

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EC2::Instance SsmAssociation

Specifies the SSM document and parameter values in AWS Systems Manager to associate with an instance.

SsmAssociations is a property of the AWS::EC2::Instance resource.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON


{
 "AssociationParameters" : [ AssociationParameter, ... ],
 "DocumentName" : String
}

YAML


 AssociationParameters: 
 - AssociationParameter 
 DocumentName: String

Properties

AssociationParameters

The input parameter values to use with the associated SSM document.

Required: No

Type: Array of AssociationParameter

Update requires: No interruption

DocumentName

The name of an SSM document to associate with the instance.

Required: Yes

Type: String

Update requires: No interruption

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

PrivateIpAddressSpecification

State

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.