@Generated(value="software.amazon.awssdk:codegen") public final class CreateDocumentRequest extends SsmRequest implements ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateDocumentRequest.Builder |
| 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
overrideConfigurationcopypublic 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.
For examples, see the following topics in the Amazon Web Services Systems Manager User Guide.
public final boolean hasRequires()
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.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.
ApplicationConfiguration document
requires an ApplicationConfigurationSchema document for validation purposes. For more
information, see What is
AppConfig? in the AppConfig User Guide.public final boolean hasAttachments()
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.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.
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
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
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.
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.
public final DocumentType documentType()
The type of document to create.
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().
DocumentTypepublic final String documentTypeAsString()
The type of document to create.
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().
DocumentTypepublic 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().
DocumentFormatpublic 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().
DocumentFormatpublic 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.
/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 final boolean hasTags()
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.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.
Key=OS,Value=Windows
Key=Environment,Value=Production
To add tags to an existing SSM document, use the AddTagsToResource operation.
public CreateDocumentRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>toBuilder in class SsmRequestpublic static CreateDocumentRequest.Builder builder()
public static Class<? extends CreateDocumentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.