Package software.amazon.awscdk.services.ssm

Class CfnDocument.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnDocument.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocument>

Enclosing class:

CfnDocument

@Stability(Stable)
public static final class CfnDocument.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDocument>

A fluent builder for CfnDocument.

Method Summary

Modifier and Type	Method	Description
CfnDocument.Builder	attachments(List<? extends Object> attachments)	A list of key-value pairs that describe attachments to a version of a document.
CfnDocument.Builder	attachments(IResolvable attachments)	A list of key-value pairs that describe attachments to a version of a document.
CfnDocument	build()
CfnDocument.Builder	content(Object content)	The content for the new SSM document in JSON or YAML.
static CfnDocument.Builder	create(software.constructs.Construct scope, String id)
CfnDocument.Builder	documentFormat(String documentFormat)	Specify the document format for the request.
CfnDocument.Builder	documentType(String documentType)	The type of document to create.
CfnDocument.Builder	name(String name)	A name for the SSM document.
CfnDocument.Builder	requires(List<? extends Object> requires)	A list of SSM documents required by a document.
CfnDocument.Builder	requires(IResolvable requires)	A list of SSM documents required by a document.
CfnDocument.Builder	tags(List<? extends CfnTag> tags)	AWS CloudFormation resource tags to apply to the document.
CfnDocument.Builder	targetType(String targetType)	Specify a target type to define the kinds of resources the document can run on.
CfnDocument.Builder	updateMethod(String updateMethod)	If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.
CfnDocument.Builder	versionName(String versionName)	An optional field specifying the version of the artifact you are creating with the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDocument.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDocument.Builder.

content

@Stability(Stable)
public CfnDocument.Builder content(Object content)

The content for the new SSM document in JSON or YAML.

For more information about the schemas for SSM document content, see SSM document schema features and examples in the AWS Systems Manager User Guide .

This parameter also supports String data types.

Parameters:

content - The content for the new SSM document in JSON or YAML. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

attachments

@Stability(Stable)
public CfnDocument.Builder attachments(IResolvable attachments)

A list of key-value pairs that describe attachments to a version of a document.

Parameters:

attachments - A list of key-value pairs that describe attachments to a version of a document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

attachments

@Stability(Stable)
public CfnDocument.Builder attachments(List<? extends Object> attachments)

A list of key-value pairs that describe attachments to a version of a document.

Parameters:

attachments - A list of key-value pairs that describe attachments to a version of a document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

documentFormat

@Stability(Stable)
public CfnDocument.Builder documentFormat(String documentFormat)

Specify the document format for the request.

JSON is the default format.

Default: - "JSON"

Parameters:

documentFormat - Specify the document format for the request. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat

documentType

@Stability(Stable)
public CfnDocument.Builder documentType(String documentType)

The type of document to create.

Parameters:

documentType - The type of document to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

name

@Stability(Stable)
public CfnDocument.Builder name(String 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
• AWSEC2
• AWSConfigRemediation
• AWSSupport

Parameters:

name - A name for the SSM document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name

requires

@Stability(Stable)
public CfnDocument.Builder requires(IResolvable 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 an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .

Parameters:

requires - A list of SSM documents required by a document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

requires

@Stability(Stable)
public CfnDocument.Builder requires(List<? extends Object> 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 an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .

Parameters:

requires - A list of SSM documents required by a document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

tags

@Stability(Stable)
public CfnDocument.Builder tags(List<? extends CfnTag> tags)

AWS CloudFormation resource tags to apply to the document.

Use tags to help you identify and categorize resources.

Parameters:

tags - AWS CloudFormation resource tags to apply to the document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

targetType

@Stability(Stable)
public CfnDocument.Builder targetType(String targetType)

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 .

Parameters:

targetType - Specify a target type to define the kinds of resources the document can run on. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype

updateMethod

@Stability(Stable)
public CfnDocument.Builder updateMethod(String updateMethod)

If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.

Replace is the default method. If you specify NewVersion for the UpdateMethod parameter, and the Name of the document does not match an existing resource, a new document is created. When you specify NewVersion , the default version of the document is changed to the newly created version.

Default: - "Replace"

Parameters:

updateMethod - If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod

versionName

@Stability(Stable)
public CfnDocument.Builder versionName(String versionName)

An optional field specifying the version of the artifact you are creating with the document.

For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

Parameters:

versionName - An optional field specifying the version of the artifact you are creating with the document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname

build

@Stability(Stable)
public CfnDocument build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDocument>

Returns:

a newly built instance of CfnDocument.