public static interface CreateDocumentRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateDocumentRequest.Builder |
attachments(AttachmentsSource... attachments)
A list of key-value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest.Builder |
attachments(Collection<AttachmentsSource> attachments)
A list of key-value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest.Builder |
attachments(Consumer<AttachmentsSource.Builder>... attachments)
A list of key-value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest.Builder |
content(String content)
The content for the new SSM document in JSON or YAML format.
|
CreateDocumentRequest.Builder |
displayName(String displayName)
An optional field where you can specify a friendly name for the SSM document.
|
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 SSM document.
|
CreateDocumentRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateDocumentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateDocumentRequest.Builder |
requires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.
|
CreateDocumentRequest.Builder |
requires(Consumer<DocumentRequires.Builder>... requires)
A list of SSM documents required by a document.
|
CreateDocumentRequest.Builder |
requires(DocumentRequires... requires)
A list of SSM documents required by a document.
|
CreateDocumentRequest.Builder |
tags(Collection<Tag> tags)
Optional metadata that you assign to a resource.
|
CreateDocumentRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Optional metadata that you assign to a resource.
|
CreateDocumentRequest.Builder |
tags(Tag... tags)
Optional metadata that you assign to a resource.
|
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateDocumentRequest.Builder content(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.
CreateDocumentRequest.Builder requires(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.CreateDocumentRequest.Builder requires(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.CreateDocumentRequest.Builder requires(Consumer<DocumentRequires.Builder>... 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.
DocumentRequires.Builder avoiding the need to create one
manually via DocumentRequires.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #requires(List.
requires - a consumer that will call methods on
DocumentRequires.Builder#requires(java.util.Collection) CreateDocumentRequest.Builder attachments(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.CreateDocumentRequest.Builder attachments(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.CreateDocumentRequest.Builder attachments(Consumer<AttachmentsSource.Builder>... attachments)
A list of key-value pairs that describe attachments to a version of a document.
This is a convenience method that creates an instance of theAttachmentsSource.Builder avoiding the need to create one
manually via AttachmentsSource.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #attachments(List.
attachments - a consumer that will call methods on
AttachmentsSource.Builder#attachments(java.util.Collection) CreateDocumentRequest.Builder name(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
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
CreateDocumentRequest.Builder displayName(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.CreateDocumentRequest.Builder versionName(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.CreateDocumentRequest.Builder documentType(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,
DocumentTypeCreateDocumentRequest.Builder documentType(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,
DocumentTypeCreateDocumentRequest.Builder documentFormat(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,
DocumentFormatCreateDocumentRequest.Builder documentFormat(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,
DocumentFormatCreateDocumentRequest.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 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.CreateDocumentRequest.Builder tags(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.
CreateDocumentRequest.Builder tags(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.
CreateDocumentRequest.Builder tags(Consumer<Tag.Builder>... 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.
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) CreateDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.