@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDocumentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDocumentRequest() |
Modifier and Type | Method and Description |
---|---|
CreateDocumentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<AttachmentsSource> |
getAttachments()
A list of key-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 |
getDisplayName()
An optional field where you can specify a friendly name for the SSM document.
|
String |
getDocumentFormat()
Specify the document format for the request.
|
String |
getDocumentType()
The type of document to create.
|
String |
getName()
A name for the SSM 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-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 |
setDisplayName(String displayName)
An optional field where you can specify a friendly name for the SSM document.
|
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 SSM 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-value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest |
withAttachments(Collection<AttachmentsSource> attachments)
A list of key-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 |
withDisplayName(String displayName)
An optional field where you can specify a friendly name for the SSM document.
|
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 SSM 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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setContent(String content)
The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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.
content
- The content for the new SSM document in JSON or YAML format. The content of the document must not exceed
64KB. This quota also includes the content specified for input parameters at runtime. 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.
public String getContent()
The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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.
For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.
public CreateDocumentRequest withContent(String content)
The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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.
content
- The content for the new SSM document in JSON or YAML format. The content of the document must not exceed
64KB. This quota also includes the content specified for input parameters at runtime. 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.
public List<DocumentRequires> getRequires()
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.
ApplicationConfiguration
document
requires an ApplicationConfigurationSchema
document for validation purposes. For more
information, see What is
AppConfig? in the AppConfig User Guide.public void setRequires(Collection<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.
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.public CreateDocumentRequest withRequires(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.
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.
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.public CreateDocumentRequest withRequires(Collection<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.
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.public List<AttachmentsSource> getAttachments()
A list of key-value pairs that describe attachments to a version of a document.
public void setAttachments(Collection<AttachmentsSource> attachments)
A list of key-value pairs that describe attachments to a version of a document.
attachments
- A list of key-value pairs that describe attachments to a version of a document.public CreateDocumentRequest withAttachments(AttachmentsSource... attachments)
A list of key-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.
attachments
- A list of key-value pairs that describe attachments to a version of a document.public CreateDocumentRequest withAttachments(Collection<AttachmentsSource> attachments)
A list of key-value pairs that describe attachments to a version of a document.
attachments
- A list of key-value pairs that describe attachments to a version of a document.public void setName(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
AWSEC2
AWSConfigRemediation
AWSSupport
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
AWSEC2
AWSConfigRemediation
AWSSupport
public String getName()
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
AWSEC2
AWSConfigRemediation
AWSSupport
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
AWSEC2
AWSConfigRemediation
AWSSupport
public CreateDocumentRequest withName(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
AWSEC2
AWSConfigRemediation
AWSSupport
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
AWSEC2
AWSConfigRemediation
AWSSupport
public void setDisplayName(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.
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.public String getDisplayName()
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.
public CreateDocumentRequest withDisplayName(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.
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.public void setVersionName(String versionName)
An optional field specifying the version of the artifact you are creating with the document. For example,
Release12.1
. This value is unique across all versions of a document, and can't be changed.
versionName
- An optional field specifying the version of the artifact you are creating with the document. For example,
Release12.1
. This value is unique across all versions of a document, and can't be changed.public String getVersionName()
An optional field specifying the version of the artifact you are creating with the document. For example,
Release12.1
. This value is unique across all versions of a document, and can't be changed.
Release12.1
. This value is unique across all versions of a document, and can't be changed.public CreateDocumentRequest withVersionName(String versionName)
An optional field specifying the version of the artifact you are creating with the document. For example,
Release12.1
. This value is unique across all versions of a document, and can't be changed.
versionName
- An optional field specifying the version of the artifact you are creating with the document. For example,
Release12.1
. This value is unique across all versions of a document, and can't be changed.public void setDocumentType(String documentType)
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
documentType
- The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for
AppConfig.
DocumentType
public String getDocumentType()
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
The DeploymentStrategy
document type is an internal-use-only document type reserved for
AppConfig.
DocumentType
public CreateDocumentRequest withDocumentType(String documentType)
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
documentType
- The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for
AppConfig.
DocumentType
public void setDocumentType(DocumentType documentType)
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
documentType
- The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for
AppConfig.
DocumentType
public CreateDocumentRequest withDocumentType(DocumentType documentType)
The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for AppConfig.
documentType
- The type of document to create.
The DeploymentStrategy
document type is an internal-use-only document type reserved for
AppConfig.
DocumentType
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.
documentFormat
- Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the
default format.DocumentFormat
public String getDocumentFormat()
Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
DocumentFormat
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.
documentFormat
- Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the
default format.DocumentFormat
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.
documentFormat
- Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the
default format.DocumentFormat
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.
documentFormat
- Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the
default format.DocumentFormat
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 Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
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.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 Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
/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.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 Amazon
Web Services resource and property types reference in the CloudFormation User Guide.
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.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-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
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-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
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.
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-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
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.
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.
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-value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
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.
public String toString()
toString
in class Object
Object.toString()
public CreateDocumentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()