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

Interface CreateDocumentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>, SdkBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
CreateDocumentRequest
public static interface CreateDocumentRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateDocumentRequest.Builder,CreateDocumentRequest>

  • Method Details

    • content

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • requires

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requires

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requires

      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.

      This is a convenience method that creates an instance of the 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<DocumentRequires>).

      Parameters:
      requires - a consumer that will call methods on DocumentRequires.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attachments

      CreateDocumentRequest.Builder attachments(Collection<AttachmentsSource> attachments)

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

      Parameters:
      attachments - A list of key-value pairs that describe attachments to a version of a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      CreateDocumentRequest.Builder attachments(AttachmentsSource... attachments)

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

      Parameters:
      attachments - A list of key-value pairs that describe attachments to a version of a document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attachments

      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 the AttachmentsSource.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<AttachmentsSource>).

      Parameters:
      attachments - a consumer that will call methods on AttachmentsSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • versionName

      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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • documentType

      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.

      Parameters:
      documentType - The type of document to create.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • documentType

      CreateDocumentRequest.Builder documentType(DocumentType documentType)

      The type of document to create.

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

      Parameters:
      documentType - The type of document to create.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • documentFormat

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

      Parameters:
      documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • documentFormat

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

      Parameters:
      documentFormat - Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetType

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      This is a convenience method that creates an instance of the 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<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.