software.amazon.awssdk.services.ssm.model

Interface CreateDocumentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>, SdkBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

CreateDocumentRequest

public static interface CreateDocumentRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

Method Summary

Modifier and Type	Method and Description
CreateDocumentRequest.Builder	attachments(AttachmentsSource... attachments) A list of key and value pairs that describe attachments to a version of a document.
CreateDocumentRequest.Builder	attachments(Collection<AttachmentsSource> attachments) A list of key and value pairs that describe attachments to a version of a document.
CreateDocumentRequest.Builder	attachments(Consumer<AttachmentsSource.Builder>... attachments) A list of key and value pairs that describe attachments to a version of a document.
CreateDocumentRequest.Builder	content(String content) A valid JSON or YAML string.
CreateDocumentRequest.Builder	documentFormat(DocumentFormat documentFormat) Specify the document format for the request.
CreateDocumentRequest.Builder	documentFormat(String documentFormat) Specify the document format for the request.
CreateDocumentRequest.Builder	documentType(DocumentType documentType) The type of document to create.
CreateDocumentRequest.Builder	documentType(String documentType) The type of document to create.
CreateDocumentRequest.Builder	name(String name) A name for the Systems Manager document.
CreateDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateDocumentRequest.Builder	targetType(String targetType) Specify a target type to define the kinds of resources the document can run on.
CreateDocumentRequest.Builder	versionName(String versionName) An optional field specifying the version of the artifact you are creating with the document.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

content

CreateDocumentRequest.Builder content(String content)

A valid JSON or YAML string.

Parameters:

content - A valid JSON or YAML string.

Returns:

Returns a reference to this object so that method calls can be chained together.

attachments

CreateDocumentRequest.Builder attachments(Collection<AttachmentsSource> attachments)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

attachments

CreateDocumentRequest.Builder attachments(AttachmentsSource... attachments)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

attachments

CreateDocumentRequest.Builder attachments(Consumer<AttachmentsSource.Builder>... attachments)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attachments(List).

Parameters:

attachments - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#attachments(List)

name

CreateDocumentRequest.Builder name(String name)

A name for the Systems Manager document.

Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

• aws

• amazon

• amzn

Parameters:

name - A name for the Systems Manager document.

Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

• aws

• amazon

• amzn

Returns:

Returns a reference to this object so that method calls can be chained together.

versionName

CreateDocumentRequest.Builder versionName(String 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 cannot be changed.

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 cannot be changed.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentType

CreateDocumentRequest.Builder documentType(String documentType)

The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

Parameters:

documentType - The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentType, DocumentType

documentType

CreateDocumentRequest.Builder documentType(DocumentType documentType)

The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

Parameters:

documentType - The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentType, DocumentType

documentFormat

CreateDocumentRequest.Builder documentFormat(String documentFormat)

Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Parameters:

documentFormat - Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentFormat, DocumentFormat

documentFormat

CreateDocumentRequest.Builder documentFormat(DocumentFormat documentFormat)

Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Parameters:

documentFormat - Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DocumentFormat, DocumentFormat

targetType

CreateDocumentRequest.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 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. 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 Types Reference in the AWS CloudFormation User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.