1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_document::_create_document_output::CreateDocumentOutputBuilder;
pub use crate::operation::create_document::_create_document_input::CreateDocumentInputBuilder;
/// Fluent builder constructing a request to `CreateDocument`.
///
/// <p>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 <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html">Amazon Web Services Systems Manager Documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct CreateDocumentFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_document::builders::CreateDocumentInputBuilder,
}
impl CreateDocumentFluentBuilder {
/// Creates a new `CreateDocument`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::create_document::CreateDocument,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::create_document::CreateDocumentError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::create_document::CreateDocumentOutput,
aws_smithy_http::result::SdkError<crate::operation::create_document::CreateDocumentError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>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.</p>
/// <p>For examples, see the following topics in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html">Create an SSM document (Amazon Web Services API)</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html">Create an SSM document (Amazon Web Services CLI)</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html">Create an SSM document (API)</a> </p> </li>
/// </ul>
pub fn content(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.content(input.into());
self
}
/// <p>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.</p>
/// <p>For examples, see the following topics in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
/// <ul>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html">Create an SSM document (Amazon Web Services API)</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html">Create an SSM document (Amazon Web Services CLI)</a> </p> </li>
/// <li> <p> <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html">Create an SSM document (API)</a> </p> </li>
/// </ul>
pub fn set_content(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_content(input);
self
}
/// Appends an item to `Requires`.
///
/// To override the contents of this collection use [`set_requires`](Self::set_requires).
///
/// <p>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 <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document for validation purposes. For more information, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">What is AppConfig?</a> in the <i>AppConfig User Guide</i>.</p>
pub fn requires(mut self, input: crate::types::DocumentRequires) -> Self {
self.inner = self.inner.requires(input);
self
}
/// <p>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 <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document for validation purposes. For more information, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">What is AppConfig?</a> in the <i>AppConfig User Guide</i>.</p>
pub fn set_requires(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::DocumentRequires>>,
) -> Self {
self.inner = self.inner.set_requires(input);
self
}
/// Appends an item to `Attachments`.
///
/// To override the contents of this collection use [`set_attachments`](Self::set_attachments).
///
/// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
pub fn attachments(mut self, input: crate::types::AttachmentsSource) -> Self {
self.inner = self.inner.attachments(input);
self
}
/// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
pub fn set_attachments(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::AttachmentsSource>>,
) -> Self {
self.inner = self.inner.set_attachments(input);
self
}
/// <p>A name for the SSM document.</p> <important>
/// <p>You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:</p>
/// <ul>
/// <li> <p> <code>aws</code> </p> </li>
/// <li> <p> <code>amazon</code> </p> </li>
/// <li> <p> <code>amzn</code> </p> </li>
/// </ul>
/// </important>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>A name for the SSM document.</p> <important>
/// <p>You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:</p>
/// <ul>
/// <li> <p> <code>aws</code> </p> </li>
/// <li> <p> <code>amazon</code> </p> </li>
/// <li> <p> <code>amzn</code> </p> </li>
/// </ul>
/// </important>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>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 <code>UpdateDocument</code> operation.</p>
pub fn display_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.display_name(input.into());
self
}
/// <p>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 <code>UpdateDocument</code> operation.</p>
pub fn set_display_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_display_name(input);
self
}
/// <p>An optional field specifying the version of the artifact you are creating with the document. For example, <code>Release12.1</code>. This value is unique across all versions of a document, and can't be changed.</p>
pub fn version_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version_name(input.into());
self
}
/// <p>An optional field specifying the version of the artifact you are creating with the document. For example, <code>Release12.1</code>. This value is unique across all versions of a document, and can't be changed.</p>
pub fn set_version_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version_name(input);
self
}
/// <p>The type of document to create.</p> <note>
/// <p>The <code>DeploymentStrategy</code> document type is an internal-use-only document type reserved for AppConfig.</p>
/// </note>
pub fn document_type(mut self, input: crate::types::DocumentType) -> Self {
self.inner = self.inner.document_type(input);
self
}
/// <p>The type of document to create.</p> <note>
/// <p>The <code>DeploymentStrategy</code> document type is an internal-use-only document type reserved for AppConfig.</p>
/// </note>
pub fn set_document_type(
mut self,
input: std::option::Option<crate::types::DocumentType>,
) -> Self {
self.inner = self.inner.set_document_type(input);
self
}
/// <p>Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
pub fn document_format(mut self, input: crate::types::DocumentFormat) -> Self {
self.inner = self.inner.document_format(input);
self
}
/// <p>Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
pub fn set_document_format(
mut self,
input: std::option::Option<crate::types::DocumentFormat>,
) -> Self {
self.inner = self.inner.set_document_format(input);
self
}
/// <p>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: <code>/AWS::EC2::Instance</code>. 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>
pub fn target_type(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.target_type(input.into());
self
}
/// <p>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: <code>/AWS::EC2::Instance</code>. 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 <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>. </p>
pub fn set_target_type(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_target_type(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>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:</p>
/// <ul>
/// <li> <p> <code>Key=OS,Value=Windows</code> </p> </li>
/// <li> <p> <code>Key=Environment,Value=Production</code> </p> </li>
/// </ul> <note>
/// <p>To add tags to an existing SSM document, use the <code>AddTagsToResource</code> operation.</p>
/// </note>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>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:</p>
/// <ul>
/// <li> <p> <code>Key=OS,Value=Windows</code> </p> </li>
/// <li> <p> <code>Key=Environment,Value=Production</code> </p> </li>
/// </ul> <note>
/// <p>To add tags to an existing SSM document, use the <code>AddTagsToResource</code> operation.</p>
/// </note>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
}