software.amazon.awssdk.services.ssm.model

Class CreateDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.CreateDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDocumentRequest
extends SsmRequest
implements ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<AttachmentsSource>	attachments() A list of key and value pairs that describe attachments to a version of a document.
static CreateDocumentRequest.Builder	builder()
String	content() A valid JSON or YAML string.
DocumentFormat	documentFormat() Specify the document format for the request.
String	documentFormatAsString() Specify the document format for the request.
DocumentType	documentType() The type of document to create.
String	documentTypeAsString() The type of document to create.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() A name for the Systems Manager document.
List<DocumentRequires>	requires() A list of SSM documents required by a document.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDocumentRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Optional metadata that you assign to a resource.
String	targetType() Specify a target type to define the kinds of resources the document can run on.
CreateDocumentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionName() An optional field specifying the version of the artifact you are creating with the document.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

content

public String content()

A valid JSON or YAML string.

Returns:

A valid JSON or YAML string.

requires

public List<DocumentRequires> requires()

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

attachments

public List<AttachmentsSource> attachments()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

name

public 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

Returns:

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

versionName

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

Returns:

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.

documentType

public DocumentType documentType()

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

If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeAsString().

Returns:

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

See Also:

DocumentType

documentTypeAsString

public String documentTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, documentType will return DocumentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentTypeAsString().

Returns:

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

See Also:

DocumentType

documentFormat

public DocumentFormat documentFormat()

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

If the service returns an enum value that is not available in the current SDK version, documentFormat will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentFormatAsString().

Returns:

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

See Also:

DocumentFormat

documentFormatAsString

public String documentFormatAsString()

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

If the service returns an enum value that is not available in the current SDK version, documentFormat will return DocumentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentFormatAsString().

Returns:

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

See Also:

DocumentFormat

targetType

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

Returns:

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.

tags

public List<Tag> tags()

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

• Key=OS,Value=Windows

• Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

• Key=OS,Value=Windows

• Key=Environment,Value=Production

To add tags to an existing SSM document, use the AddTagsToResource action.

toBuilder

public CreateDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static CreateDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDocumentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo