CfnDocument¶
-
class
aws_cdk.aws_ssm.
CfnDocument
(scope, id, *, content, attachments=None, document_format=None, document_type=None, name=None, requires=None, tags=None, target_type=None, update_method=None, version_name=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::SSM::Document
.The
AWS::SSM::Document
resource creates a Systems Manager (SSM) document in AWS Systems Manager . This document defines the actions that Systems Manager performs on your AWS resources. .. epigraph:This resource does not support CloudFormation drift detection.
- CloudformationResource
AWS::SSM::Document
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ssm as ssm # content: Any cfn_document = ssm.CfnDocument(self, "MyCfnDocument", content=content, # the properties below are optional attachments=[ssm.CfnDocument.AttachmentsSourceProperty( key="key", name="name", values=["values"] )], document_format="documentFormat", document_type="documentType", name="name", requires=[ssm.CfnDocument.DocumentRequiresProperty( name="name", version="version" )], tags=[CfnTag( key="key", value="value" )], target_type="targetType", update_method="updateMethod", version_name="versionName" )
Create a new
AWS::SSM::Document
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
content (
Any
) – The content for the new SSM document in JSON or YAML. .. epigraph:: This parameter also supportsString
data types.attachments (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AttachmentsSourceProperty
]],None
]) – A list of key-value pairs that describe attachments to a version of a document.document_format (
Optional
[str
]) – Specify the document format for the request. JSON is the default format.document_type (
Optional
[str
]) – The type of document to create. Allowed Values :ApplicationConfigurationSchema
|Automation
|Automation.ChangeTemplate
|Command
|DeploymentStrategy
|Package
|Policy
|Session
name (
Optional
[str
]) – A name for the SSM document. .. epigraph:: You can’t use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: -aws-
-amazon
-amzn
requires (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DocumentRequiresProperty
]],None
]) – A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, anApplicationConfiguration
document requires anApplicationConfigurationSchema
document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .tags (
Optional
[Sequence
[CfnTag
]]) – AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.target_type (
Optional
[str
]) – Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value:/AWS::EC2::Instance
. If you specify a value of ‘/’ the document can run on all types of resources. If you don’t specify a value, the document can’t run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide .update_method (
Optional
[str
]) –AWS::SSM::Document.UpdateMethod
.version_name (
Optional
[str
]) – An optional field specifying the version of the artifact you are creating with the document. For example, “Release 12, Update 6”. This value is unique across all versions of a document, and can’t be changed.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::SSM::Document'¶
-
attachments
¶ A list of key-value pairs that describe attachments to a version of a document.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,AttachmentsSourceProperty
]],None
]
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
content
¶ The content for the new SSM document in JSON or YAML.
This parameter also supports
String
data types.
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
document_format
¶ Specify the document format for the request.
JSON is the default format.
- Link
- Return type
Optional
[str
]
-
document_type
¶ The type of document to create.
Allowed Values :
ApplicationConfigurationSchema
|Automation
|Automation.ChangeTemplate
|Command
|DeploymentStrategy
|Package
|Policy
|Session
- Link
- Return type
Optional
[str
]
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
name
¶ A name for the SSM document.
You can’t use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:
aws-
amazon
amzn
- Link
- Return type
Optional
[str
]
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
requires
¶ A list of SSM documents required by a document.
This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an
ApplicationConfiguration
document requires anApplicationConfigurationSchema
document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,DocumentRequiresProperty
]],None
]
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
AWS CloudFormation resource tags to apply to the document.
Use tags to help you identify and categorize resources.
-
target_type
¶ Specify a target type to define the kinds of resources the document can run on.
For example, to run a document on EC2 instances, specify the following value:
/AWS::EC2::Instance
. If you specify a value of ‘/’ the document can run on all types of resources. If you don’t specify a value, the document can’t run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide .- Link
- Return type
Optional
[str
]
-
update_method
¶ AWS::SSM::Document.UpdateMethod
.- Link
- Return type
Optional
[str
]
-
version_name
¶ An optional field specifying the version of the artifact you are creating with the document.
For example, “Release 12, Update 6”. This value is unique across all versions of a document, and can’t be changed.
- Link
- Return type
Optional
[str
]
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
AttachmentsSourceProperty¶
-
class
CfnDocument.
AttachmentsSourceProperty
(*, key=None, name=None, values=None)¶ Bases:
object
Identifying information about a document attachment, including the file name and a key-value pair that identifies the location of an attachment to a document.
- Parameters
key (
Optional
[str
]) – The key of a key-value pair that identifies the location of an attachment to a document.name (
Optional
[str
]) – The name of the document attachment file.values (
Optional
[Sequence
[str
]]) – The value of a key-value pair that identifies the location of an attachment to a document. The format for Value depends on the type of key you specify. - For the key SourceUrl , the value is an S3 bucket location. For example:"Values": [ "s3://doc-example-bucket/my-folder" ]
- For the key S3FileUrl , the value is a file in an S3 bucket. For example:"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
- For the key AttachmentReference , the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:"Values": [ "MyOtherDocument/3/my-other-file.py" ]
However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ssm as ssm attachments_source_property = ssm.CfnDocument.AttachmentsSourceProperty( key="key", name="name", values=["values"] )
Attributes
-
key
¶ The key of a key-value pair that identifies the location of an attachment to a document.
-
name
¶ The name of the document attachment file.
-
values
¶ The value of a key-value pair that identifies the location of an attachment to a document.
The format for Value depends on the type of key you specify.
For the key SourceUrl , the value is an S3 bucket location. For example:
"Values": [ "s3://doc-example-bucket/my-folder" ]
For the key S3FileUrl , the value is a file in an S3 bucket. For example:
"Values": [ "s3://doc-example-bucket/my-folder/my-file.py" ]
For the key AttachmentReference , the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:
"Values": [ "MyOtherDocument/3/my-other-file.py" ]
However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:
"Values": [ "arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py" ]
DocumentRequiresProperty¶
-
class
CfnDocument.
DocumentRequiresProperty
(*, name=None, version=None)¶ Bases:
object
An SSM document required by the current document.
- Parameters
name (
Optional
[str
]) – The name of the required SSM document. The name can be an Amazon Resource Name (ARN).version (
Optional
[str
]) – The document version required by the current document.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_ssm as ssm document_requires_property = ssm.CfnDocument.DocumentRequiresProperty( name="name", version="version" )
Attributes
-
name
¶ The name of the required SSM document.
The name can be an Amazon Resource Name (ARN).
-
version
¶ The document version required by the current document.