Struct aws_sdk_ssm::operation::create_document::builders::CreateDocumentInputBuilder

#[non_exhaustive]
pub struct CreateDocumentInputBuilder { /* private fields */ }

A builder for CreateDocumentInput.

Implementations

impl CreateDocumentInputBuilder

pub fn content(self, input: impl Into<String>) -> Self

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.

• Create an SSM document (console)

• Create an SSM document (command line)

• Create an SSM document (API)

This field is required.

pub fn set_content(self, input: Option<String>) -> Self

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.

• Create an SSM document (console)

• Create an SSM document (command line)

• Create an SSM document (API)

pub fn get_content(&self) -> &Option<String>

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.

• Create an SSM document (console)

• Create an SSM document (command line)

• Create an SSM document (API)

pub fn requires(self, input: DocumentRequires) -> Self

Appends an item to requires.

To override the contents of this collection use set_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.

pub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self

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.

pub fn get_requires(&self) -> &Option<Vec<DocumentRequires>>

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.

pub fn attachments(self, input: AttachmentsSource) -> Self

Appends an item to attachments.

To override the contents of this collection use set_attachments.

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

pub fn set_attachments(self, input: Option<Vec<AttachmentsSource>>) -> Self

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

pub fn get_attachments(&self) -> &Option<Vec<AttachmentsSource>>

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

pub fn name(self, input: impl Into<String>) -> Self

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

• AWSEC2

• AWSConfigRemediation

• AWSSupport

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

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

• AWSEC2

• AWSConfigRemediation

• AWSSupport

pub fn get_name(&self) -> &Option<String>

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

• AWSEC2

• AWSConfigRemediation

• AWSSupport

pub fn display_name(self, input: impl Into<String>) -> Self

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.

pub fn set_display_name(self, input: Option<String>) -> Self

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.

pub fn get_display_name(&self) -> &Option<String>

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.

pub fn version_name(self, input: impl Into<String>) -> Self

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.

pub fn set_version_name(self, input: Option<String>) -> Self

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.

pub fn get_version_name(&self) -> &Option<String>

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.

pub fn document_type(self, input: DocumentType) -> Self

The type of document to create.

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

pub fn set_document_type(self, input: Option<DocumentType>) -> Self

The type of document to create.

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

pub fn get_document_type(&self) -> &Option<DocumentType>

The type of document to create.

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

pub fn document_format(self, input: DocumentFormat) -> Self

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

pub fn set_document_format(self, input: Option<DocumentFormat>) -> Self

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

pub fn get_document_format(&self) -> &Option<DocumentFormat>

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

pub fn target_type(self, input: impl Into<String>) -> Self

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.

pub fn set_target_type(self, input: Option<String>) -> Self

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.

pub fn get_target_type(&self) -> &Option<String>

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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.

pub fn build(self) -> Result<CreateDocumentInput, BuildError>

Consumes the builder and constructs a CreateDocumentInput.

impl CreateDocumentInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateDocumentOutput, SdkError<CreateDocumentError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateDocumentInputBuilder

fn clone(&self) -> CreateDocumentInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDocumentInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateDocumentInputBuilder

fn default() -> CreateDocumentInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateDocumentInputBuilder

fn eq(&self, other: &CreateDocumentInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDocumentInputBuilder