software.amazon.awscdk.services.ssm

Class CfnDocumentProps.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnDocumentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDocumentProps>

Enclosing interface:

CfnDocumentProps

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

A builder for CfnDocumentProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDocumentProps.Builder	attachments(IResolvable attachments) Sets the value of CfnDocumentProps.getAttachments()
CfnDocumentProps.Builder	attachments(List<? extends Object> attachments) Sets the value of CfnDocumentProps.getAttachments()
CfnDocumentProps	build() Builds the configured instance.
CfnDocumentProps.Builder	content(Object content) Sets the value of CfnDocumentProps.getContent()
CfnDocumentProps.Builder	documentFormat(String documentFormat) Sets the value of CfnDocumentProps.getDocumentFormat()
CfnDocumentProps.Builder	documentType(String documentType) Sets the value of CfnDocumentProps.getDocumentType()
CfnDocumentProps.Builder	name(String name) Sets the value of CfnDocumentProps.getName()
CfnDocumentProps.Builder	requires(IResolvable requires) Sets the value of CfnDocumentProps.getRequires()
CfnDocumentProps.Builder	requires(List<? extends Object> requires) Sets the value of CfnDocumentProps.getRequires()
CfnDocumentProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnDocumentProps.getTags()
CfnDocumentProps.Builder	targetType(String targetType) Sets the value of CfnDocumentProps.getTargetType()
CfnDocumentProps.Builder	updateMethod(String updateMethod) Sets the value of CfnDocumentProps.getUpdateMethod()
CfnDocumentProps.Builder	versionName(String versionName) Sets the value of CfnDocumentProps.getVersionName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

content

@Stability(value=Stable)
public CfnDocumentProps.Builder content(Object content)

Sets the value of CfnDocumentProps.getContent()

Parameters:

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

This parameter also supports String data types.

Returns:

this

attachments

@Stability(value=Stable)
public CfnDocumentProps.Builder attachments(IResolvable attachments)

Sets the value of CfnDocumentProps.getAttachments()

Parameters:

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

Returns:

this

attachments

@Stability(value=Stable)
public CfnDocumentProps.Builder attachments(List<? extends Object> attachments)

Sets the value of CfnDocumentProps.getAttachments()

Parameters:

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

Returns:

this

documentFormat

@Stability(value=Stable)
public CfnDocumentProps.Builder documentFormat(String documentFormat)

Sets the value of CfnDocumentProps.getDocumentFormat()

Parameters:

documentFormat - Specify the document format for the request. JSON is the default format.

Returns:

this

documentType

@Stability(value=Stable)
public CfnDocumentProps.Builder documentType(String documentType)

Sets the value of CfnDocumentProps.getDocumentType()

Parameters:

documentType - The type of document to create. Allowed Values : ApplicationConfigurationSchema | Automation | Automation.ChangeTemplate | Command | DeploymentStrategy | Package | Policy | Session

Returns:

this

name

@Stability(value=Stable)
public CfnDocumentProps.Builder name(String name)

Sets the value of CfnDocumentProps.getName()

Parameters:

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

Returns:

this

requires

@Stability(value=Stable)
public CfnDocumentProps.Builder requires(IResolvable requires)

Sets the value of CfnDocumentProps.getRequires()

Parameters:

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 .

Returns:

this

requires

@Stability(value=Stable)
public CfnDocumentProps.Builder requires(List<? extends Object> requires)

Sets the value of CfnDocumentProps.getRequires()

Parameters:

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 .

Returns:

this

tags

@Stability(value=Stable)
public CfnDocumentProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDocumentProps.getTags()

Parameters:

tags - AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.

Returns:

this

targetType

@Stability(value=Stable)
public CfnDocumentProps.Builder targetType(String targetType)

Sets the value of CfnDocumentProps.getTargetType()

Parameters:

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 .

Returns:

this

updateMethod

@Stability(value=Stable)
public CfnDocumentProps.Builder updateMethod(String updateMethod)

Sets the value of CfnDocumentProps.getUpdateMethod()

Parameters:

updateMethod - `AWS::SSM::Document.UpdateMethod`.

Returns:

this

versionName

@Stability(value=Stable)
public CfnDocumentProps.Builder versionName(String versionName)

Sets the value of CfnDocumentProps.getVersionName()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnDocumentProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnDocumentProps

Throws:

NullPointerException - if any required attribute was not provided