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-value pairs that describe attachments to a version of a document.
static CreateDocumentRequest.Builder	builder()
String	content() The content for the new SSM document in JSON or YAML format.
String	displayName() An optional field where you can specify a friendly name for the SSM document.
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)
boolean	hasAttachments() For responses, this returns true if the service returned a value for the Attachments property.
int	hashCode()
boolean	hasRequires() For responses, this returns true if the service returned a value for the Requires property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() A name for the SSM 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 final String content()

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

• Create an SSM document (Amazon Web Services API)

• Create an SSM document (Amazon Web Services CLI)

• Create an SSM document (API)

Returns:

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.

• Create an SSM document (Amazon Web Services API)

• Create an SSM document (Amazon Web Services CLI)

• Create an SSM document (API)

hasRequires

public final boolean hasRequires()

For responses, this returns true if the service returned a value for the Requires property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

requires

public final List<DocumentRequires> requires()

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an 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 AppConfig? in the AppConfig User Guide.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequires() method.

Returns:

A list of SSM documents required by a document. This parameter is used exclusively by AppConfig. When a user creates an 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 AppConfig? in the AppConfig User Guide.

hasAttachments

public final boolean hasAttachments()

For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

attachments

public final List<AttachmentsSource> attachments()

A list of key-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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttachments() method.

Returns:

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

name

public final String name()

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

• aws-

• amazon

• amzn

Returns:

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

• aws-

• amazon

• amzn

displayName

public final String displayName()

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Returns:

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

versionName

public final 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 can't 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 can't be changed.

documentType

public final DocumentType documentType()

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

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.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

See Also:

DocumentType

documentTypeAsString

public final String documentTypeAsString()

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

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.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

See Also:

DocumentType

documentFormat

public final DocumentFormat documentFormat()

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. 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 JSON, YAML, or TEXT. JSON is the default format.

See Also:

DocumentFormat

documentFormatAsString

public final String documentFormatAsString()

Specify the document format for the request. The document format can be JSON, YAML, or TEXT. 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 JSON, YAML, or TEXT. JSON is the default format.

See Also:

DocumentFormat

targetType

public final 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 Amazon Web Services resource and property types reference in the 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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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-value pairs:

• Key=OS,Value=Windows

• Key=Environment,Value=Production

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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-value pairs:

• Key=OS,Value=Windows

• Key=Environment,Value=Production

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

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo