Struct aws_sdk_ssm::client::fluent_builders::CreateDocument
source · [−]pub struct CreateDocument { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateDocument
.
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
Implementations
sourceimpl CreateDocument
impl CreateDocument
sourcepub async fn send(
self
) -> Result<CreateDocumentOutput, SdkError<CreateDocumentError>>
pub async fn send(
self
) -> Result<CreateDocumentOutput, SdkError<CreateDocumentError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn content(self, input: impl Into<String>) -> Self
pub fn content(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_content(self, input: Option<String>) -> Self
pub fn set_content(self, input: Option<String>) -> Self
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.
sourcepub fn requires(self, input: DocumentRequires) -> Self
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.
sourcepub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self
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.
sourcepub fn attachments(self, input: AttachmentsSource) -> Self
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.
sourcepub fn set_attachments(self, input: Option<Vec<AttachmentsSource>>) -> Self
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.
sourcepub fn name(self, input: impl Into<String>) -> Self
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
sourcepub fn set_name(self, input: Option<String>) -> Self
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
sourcepub fn display_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_display_name(self, input: Option<String>) -> Self
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.
sourcepub fn version_name(self, input: impl Into<String>) -> Self
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, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
sourcepub fn set_version_name(self, input: Option<String>) -> Self
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, "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed.
sourcepub fn document_type(self, input: DocumentType) -> Self
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.
sourcepub fn set_document_type(self, input: Option<DocumentType>) -> Self
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.
sourcepub fn document_format(self, input: DocumentFormat) -> Self
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.
sourcepub fn set_document_format(self, input: Option<DocumentFormat>) -> Self
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.
sourcepub fn target_type(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_target_type(self, input: Option<String>) -> Self
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.
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.
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.
Trait Implementations
sourceimpl Clone for CreateDocument
impl Clone for CreateDocument
sourcefn clone(&self) -> CreateDocument
fn clone(&self) -> CreateDocument
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateDocument
impl Send for CreateDocument
impl Sync for CreateDocument
impl Unpin for CreateDocument
impl !UnwindSafe for CreateDocument
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more