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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::test_type::_test_type_output::TestTypeOutputBuilder;
pub use crate::operation::test_type::_test_type_input::TestTypeInputBuilder;
impl crate::operation::test_type::builders::TestTypeInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::test_type::TestTypeOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::test_type::TestTypeError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.test_type();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `TestType`.
///
/// <p>Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.</p>
/// <ul>
/// <li>
/// <p>For resource types, this includes passing all contracts tests defined for the type.</p></li>
/// <li>
/// <p>For modules, this includes determining if the module's model meets all necessary requirements.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public extension prior to publishing</a> in the <i>CloudFormation CLI User Guide</i>.</p>
/// <p>If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing.</p>
/// <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
/// <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test status and test status description for the extension.</p>
/// <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation CLI User Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct TestTypeFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::test_type::builders::TestTypeInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl crate::client::customize::internal::CustomizableSend<crate::operation::test_type::TestTypeOutput, crate::operation::test_type::TestTypeError>
for TestTypeFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<crate::operation::test_type::TestTypeOutput, crate::operation::test_type::TestTypeError>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl TestTypeFluentBuilder {
/// Creates a new `TestTypeFluentBuilder`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the TestType as a reference.
pub fn as_input(&self) -> &crate::operation::test_type::builders::TestTypeInputBuilder {
&self.inner
}
/// 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::test_type::TestTypeOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::test_type::TestTypeError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::test_type::TestType::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::test_type::TestType::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<crate::operation::test_type::TestTypeOutput, crate::operation::test_type::TestTypeError, Self>
{
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The Amazon Resource Name (ARN) of the extension.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the extension.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the extension.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_arn()
}
/// <p>The type of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn r#type(mut self, input: crate::types::ThirdPartyType) -> Self {
self.inner = self.inner.r#type(input);
self
}
/// <p>The type of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn set_type(mut self, input: ::std::option::Option<crate::types::ThirdPartyType>) -> Self {
self.inner = self.inner.set_type(input);
self
}
/// <p>The type of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn get_type(&self) -> &::std::option::Option<crate::types::ThirdPartyType> {
self.inner.get_type()
}
/// <p>The name of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn type_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.type_name(input.into());
self
}
/// <p>The name of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn set_type_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_type_name(input);
self
}
/// <p>The name of the extension to test.</p>
/// <p>Conditional: You must specify <code>Arn</code>, or <code>TypeName</code> and <code>Type</code>.</p>
pub fn get_type_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_type_name()
}
/// <p>The version of the extension to test.</p>
/// <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and <code>Type</code>.</p>
/// <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.</p>
pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.version_id(input.into());
self
}
/// <p>The version of the extension to test.</p>
/// <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and <code>Type</code>.</p>
/// <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.</p>
pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_version_id(input);
self
}
/// <p>The version of the extension to test.</p>
/// <p>You can specify the version id with either <code>Arn</code>, or with <code>TypeName</code> and <code>Type</code>.</p>
/// <p>If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.</p>
pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_version_id()
}
/// <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
/// <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
/// <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:</p>
/// <ul>
/// <li>
/// <p><code>GetObject</code></p></li>
/// <li>
/// <p><code>PutObject</code></p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
pub fn log_delivery_bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.log_delivery_bucket(input.into());
self
}
/// <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
/// <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
/// <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:</p>
/// <ul>
/// <li>
/// <p><code>GetObject</code></p></li>
/// <li>
/// <p><code>PutObject</code></p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
pub fn set_log_delivery_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_log_delivery_bucket(input);
self
}
/// <p>The S3 bucket to which CloudFormation delivers the contract test execution logs.</p>
/// <p>CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of <code>PASSED</code> or <code>FAILED</code>.</p>
/// <p>The user calling <code>TestType</code> must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:</p>
/// <ul>
/// <li>
/// <p><code>GetObject</code></p></li>
/// <li>
/// <p><code>PutObject</code></p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
pub fn get_log_delivery_bucket(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_log_delivery_bucket()
}
}