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 and value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest.Builder |
attachments(Collection<AttachmentsSource> attachments)
A list of key and value pairs that describe attachments to a version of a document.
|
CreateDocumentRequest.Builder |
attachments(Consumer<AttachmentsSource.Builder>... attachments)
A list of key and 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 |
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 Systems Manager 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. 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.
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.
CreateDocumentRequest.Builder requires(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.
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.CreateDocumentRequest.Builder requires(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.
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.CreateDocumentRequest.Builder requires(Consumer<DocumentRequires.Builder>... 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.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #requires(List) .requires - a consumer that will call methods on List.Builder #requires(List) CreateDocumentRequest.Builder attachments(Collection<AttachmentsSource> attachments)
A list of key and value pairs that describe attachments to a version of a document.
attachments - A list of key and value pairs that describe attachments to a version of a document.CreateDocumentRequest.Builder attachments(AttachmentsSource... attachments)
A list of key and value pairs that describe attachments to a version of a document.
attachments - A list of key and value pairs that describe attachments to a version of a document.CreateDocumentRequest.Builder attachments(Consumer<AttachmentsSource.Builder>... attachments)
A list of key and value pairs that describe attachments to a version of a document.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #attachments(List) .attachments - a consumer that will call methods on List.Builder #attachments(List) CreateDocumentRequest.Builder name(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
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
CreateDocumentRequest.Builder versionName(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.
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.CreateDocumentRequest.Builder documentType(String documentType)
The type of document to create.
documentType - The type of document to create.DocumentType,
DocumentTypeCreateDocumentRequest.Builder documentType(DocumentType documentType)
The type of document to create.
documentType - The type of document to create.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 AWS resource and property types reference in the AWS 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 AWS resource and property types reference in the AWS 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 name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource action.
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.
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 name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource action.
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.
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 name/value pairs:
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource action.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.