CreateDocumentRequest (AWS Java SDK for the AWS Simple Systems Management (SSM) Service 1.11.916 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.simplesystemsmanagement.model.CreateDocumentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateDocumentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateDocumentRequest()

Constructors
Constructor and Description
`CreateDocumentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateDocumentRequest`	`clone()`
`boolean`	`equals(Object obj)`
`List<AttachmentsSource>`	`getAttachments()` A list of key and value pairs that describe attachments to a version of a document.
`String`	`getContent()` The content for the new SSM document in JSON or YAML format.
`String`	`getDocumentFormat()` Specify the document format for the request.
`String`	`getDocumentType()` The type of document to create.
`String`	`getName()` A name for the Systems Manager document.
`List<DocumentRequires>`	`getRequires()` A list of SSM documents required by a document.
`List<Tag>`	`getTags()` Optional metadata that you assign to a resource.
`String`	`getTargetType()` Specify a target type to define the kinds of resources the document can run on.
`String`	`getVersionName()` An optional field specifying the version of the artifact you are creating with the document.
`int`	`hashCode()`
`void`	`setAttachments(Collection<AttachmentsSource> attachments)` A list of key and value pairs that describe attachments to a version of a document.
`void`	`setContent(String content)` The content for the new SSM document in JSON or YAML format.
`void`	`setDocumentFormat(DocumentFormat documentFormat)` Specify the document format for the request.
`void`	`setDocumentFormat(String documentFormat)` Specify the document format for the request.
`void`	`setDocumentType(DocumentType documentType)` The type of document to create.
`void`	`setDocumentType(String documentType)` The type of document to create.
`void`	`setName(String name)` A name for the Systems Manager document.
`void`	`setRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`void`	`setTags(Collection<Tag> tags)` Optional metadata that you assign to a resource.
`void`	`setTargetType(String targetType)` Specify a target type to define the kinds of resources the document can run on.
`void`	`setVersionName(String versionName)` An optional field specifying the version of the artifact you are creating with the document.
`String`	`toString()` Returns a string representation of this object.
`CreateDocumentRequest`	`withAttachments(AttachmentsSource... attachments)` A list of key and value pairs that describe attachments to a version of a document.
`CreateDocumentRequest`	`withAttachments(Collection<AttachmentsSource> attachments)` A list of key and value pairs that describe attachments to a version of a document.
`CreateDocumentRequest`	`withContent(String content)` The content for the new SSM document in JSON or YAML format.
`CreateDocumentRequest`	`withDocumentFormat(DocumentFormat documentFormat)` Specify the document format for the request.
`CreateDocumentRequest`	`withDocumentFormat(String documentFormat)` Specify the document format for the request.
`CreateDocumentRequest`	`withDocumentType(DocumentType documentType)` The type of document to create.
`CreateDocumentRequest`	`withDocumentType(String documentType)` The type of document to create.
`CreateDocumentRequest`	`withName(String name)` A name for the Systems Manager document.
`CreateDocumentRequest`	`withRequires(Collection<DocumentRequires> requires)` A list of SSM documents required by a document.
`CreateDocumentRequest`	`withRequires(DocumentRequires... requires)` A list of SSM documents required by a document.
`CreateDocumentRequest`	`withTags(Collection<Tag> tags)` Optional metadata that you assign to a resource.
`CreateDocumentRequest`	`withTags(Tag... tags)` Optional metadata that you assign to a resource.
`CreateDocumentRequest`	`withTargetType(String targetType)` Specify a target type to define the kinds of resources the document can run on.
`CreateDocumentRequest`	`withVersionName(String versionName)` An optional field specifying the version of the artifact you are creating with the document.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateDocumentRequest
```
public CreateDocumentRequest()
```
- Method Detail
  - setContent
```
public void setContent(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 AWS Systems Manager User Guide.
    Parameters:
    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 AWS Systems Manager User Guide.
    
    Create an SSM document (AWS API)
    
    Create an SSM document (AWS CLI)
    
    Create an SSM document (API)
  - getContent
```
public String getContent()
```
    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 AWS Systems Manager User Guide.
    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 AWS Systems Manager User Guide.
    
    Create an SSM document (AWS API)
    
    Create an SSM document (AWS CLI)
    
    Create an SSM document (API)
  - withContent
```
public CreateDocumentRequest withContent(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 AWS Systems Manager User Guide.
    Parameters:
    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 AWS Systems Manager User Guide.
    
    Create an SSM document (AWS API)
    
    Create an SSM document (AWS CLI)
    
    Create an SSM document (API)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequires
```
public List<DocumentRequires> getRequires()
```
    A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    Returns:
    
    A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
  - setRequires
```
public void setRequires(Collection<DocumentRequires> requires)
```
    A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
  - withRequires
```
public CreateDocumentRequest withRequires(DocumentRequires... requires)
```
    A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequires(java.util.Collection) or withRequires(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRequires
```
public CreateDocumentRequest withRequires(Collection<DocumentRequires> requires)
```
    A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    Parameters:
    
    requires - A list of SSM documents required by a document. This parameter is used exclusively by AWS 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 AWS AppConfig in the AWS Systems Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttachments
```
public List<AttachmentsSource> getAttachments()
```
    A list of key and value pairs that describe attachments to a version of a document.
    
    Returns:
    
    A list of key and value pairs that describe attachments to a version of a document.
  - setAttachments
```
public void setAttachments(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.
  - withAttachments
```
public CreateDocumentRequest withAttachments(AttachmentsSource... attachments)
```
    A list of key and value pairs that describe attachments to a version of a document.
    
    NOTE: This method appends the values to the existing list (if any). Use setAttachments(java.util.Collection) or withAttachments(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAttachments
```
public CreateDocumentRequest withAttachments(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.
  - setName
```
public void setName(String name)
```
    A name for the Systems Manager 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
    Parameters:
    name - A name for the Systems Manager 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
  - getName
```
public String getName()
```
    A name for the Systems Manager 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:
    A name for the Systems Manager 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
  - withName
```
public CreateDocumentRequest withName(String name)
```
    A name for the Systems Manager 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
    Parameters:
    name - A name for the Systems Manager 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionName
```
public void setVersionName(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.
  - getVersionName
```
public String getVersionName()
```
    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.
  - withVersionName
```
public CreateDocumentRequest withVersionName(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.
  - setDocumentType
```
public void setDocumentType(String documentType)
```
    The type of document to create.
    
    Parameters:
    
    documentType - The type of document to create.
    
    See Also:
    
    DocumentType
  - getDocumentType
```
public String getDocumentType()
```
    The type of document to create.
    
    Returns:
    
    The type of document to create.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public CreateDocumentRequest withDocumentType(String documentType)
```
    The type of document to create.
    
    Parameters:
    
    documentType - The type of document to create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentType
```
public void setDocumentType(DocumentType documentType)
```
    The type of document to create.
    
    Parameters:
    
    documentType - The type of document to create.
    
    See Also:
    
    DocumentType
  - withDocumentType
```
public CreateDocumentRequest withDocumentType(DocumentType documentType)
```
    The type of document to create.
    
    Parameters:
    
    documentType - The type of document to create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentType
  - setDocumentFormat
```
public void setDocumentFormat(String documentFormat)
```
    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Parameters:
    
    documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    See Also:
    
    DocumentFormat
  - getDocumentFormat
```
public String getDocumentFormat()
```
    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    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
  - withDocumentFormat
```
public CreateDocumentRequest withDocumentFormat(String documentFormat)
```
    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Parameters:
    
    documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setDocumentFormat
```
public void setDocumentFormat(DocumentFormat documentFormat)
```
    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Parameters:
    
    documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    See Also:
    
    DocumentFormat
  - withDocumentFormat
```
public CreateDocumentRequest withDocumentFormat(DocumentFormat documentFormat)
```
    Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Parameters:
    
    documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setTargetType
```
public void setTargetType(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. 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.
  - getTargetType
```
public String getTargetType()
```
    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:
    
    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.
  - withTargetType
```
public CreateDocumentRequest withTargetType(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. 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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.
    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.
  - setTags
```
public void setTags(Collection<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.
    Parameters:
    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.
  - withTags
```
public CreateDocumentRequest withTags(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateDocumentRequest withTags(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateDocumentRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class CreateDocumentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateDocumentRequest

Method Detail

setContent

getContent

withContent

getRequires

setRequires

withRequires

withRequires

getAttachments

setAttachments

withAttachments

withAttachments

setName

getName

withName

setVersionName

getVersionName

withVersionName

setDocumentType

getDocumentType

withDocumentType

setDocumentType

withDocumentType

setDocumentFormat

getDocumentFormat

withDocumentFormat

setDocumentFormat

withDocumentFormat

setTargetType

getTargetType

withTargetType

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone