Package software.amazon.awssdk.services.ssm.model

Class CreateDocumentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.CreateDocumentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDocumentRequest extends SsmRequest implements ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

  • Method Details

    • content

      public final 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.

      Returns:
      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.

    • hasRequires

      public final boolean hasRequires()
      For responses, this returns true if the service returned a value for the Requires property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • requires

      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.

      Returns:
      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.

    • hasAttachments

      public final boolean hasAttachments()
      For responses, this returns true if the service returned a value for the Attachments property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • attachments

      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.

      Returns:
      A list of key-value pairs that describe attachments to a version of a document.

    • name

      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

      Returns:
      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

    • displayName

      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.

      Returns:
      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.

    • versionName

      public final 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.

      Returns:
      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.

    • documentType

      public final DocumentType documentType()

      The type of document to create.

      The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

      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().

      Returns:
      The type of document to create.

      The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

      See Also:

    • documentTypeAsString

      public final String documentTypeAsString()

      The type of document to create.

      The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

      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().

      Returns:
      The type of document to create.

      The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

      See Also:

    • documentFormat

      public 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().

      Returns:
      Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
      See Also:

    • documentFormatAsString

      public 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().

      Returns:
      Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
      See Also:

    • targetType

      public 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.

      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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • tags

      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.

      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-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      To add tags to an existing SSM document, use the AddTagsToResource operation.

    • toBuilder

      public CreateDocumentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDocumentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDocumentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.