aws_sdk_cloudformation/client/
validate_template.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ValidateTemplate`](crate::operation::validate_template::builders::ValidateTemplateFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`template_body(impl Into<String>)`](crate::operation::validate_template::builders::ValidateTemplateFluentBuilder::template_body) / [`set_template_body(Option<String>)`](crate::operation::validate_template::builders::ValidateTemplateFluentBuilder::set_template_body):<br>required: **false**<br><p>Structure that contains the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p><br>
7    ///   - [`template_url(impl Into<String>)`](crate::operation::validate_template::builders::ValidateTemplateFluentBuilder::template_url) / [`set_template_url(Option<String>)`](crate::operation::validate_template::builders::ValidateTemplateFluentBuilder::set_template_url):<br>required: **false**<br><p>The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p><br>
8    /// - On success, responds with [`ValidateTemplateOutput`](crate::operation::validate_template::ValidateTemplateOutput) with field(s):
9    ///   - [`parameters(Option<Vec::<TemplateParameter>>)`](crate::operation::validate_template::ValidateTemplateOutput::parameters): <p>A list of <code>TemplateParameter</code> structures.</p>
10    ///   - [`description(Option<String>)`](crate::operation::validate_template::ValidateTemplateOutput::description): <p>The description found within the template.</p>
11    ///   - [`capabilities(Option<Vec::<Capability>>)`](crate::operation::validate_template::ValidateTemplateOutput::capabilities): <p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <code>CreateStack</code> or <code>UpdateStack</code> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>
12    ///   - [`capabilities_reason(Option<String>)`](crate::operation::validate_template::ValidateTemplateOutput::capabilities_reason): <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
13    ///   - [`declared_transforms(Option<Vec::<String>>)`](crate::operation::validate_template::ValidateTemplateOutput::declared_transforms): <p>A list of the transforms that are declared in the template.</p>
14    /// - On failure, responds with [`SdkError<ValidateTemplateError>`](crate::operation::validate_template::ValidateTemplateError)
15    pub fn validate_template(&self) -> crate::operation::validate_template::builders::ValidateTemplateFluentBuilder {
16        crate::operation::validate_template::builders::ValidateTemplateFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_cloudformation/client/validate_template.rs

aws_sdk_cloudformation/client/
validate_template.rs
