1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`RegisterType`](crate::operation::register_type::builders::RegisterTypeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`r#type(RegistryType)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::type) / [`set_type(Option<RegistryType>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_type):<br>required: **false**<br><p>The kind of extension.</p><br>
    ///   - [`type_name(impl Into<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::type_name) / [`set_type_name(Option<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_type_name):<br>required: **true**<br><p>The name of the extension being registered.</p> <p>We suggest that extension names adhere to the following patterns:</p> <ul>  <li>   <p>For resource types, <i>company_or_organization</i>::<i>service</i>::<i>type</i>.</p></li>  <li>   <p>For modules, <i>company_or_organization</i>::<i>service</i>::<i>type</i>::MODULE.</p></li>  <li>   <p>For hooks, <i>MyCompany</i>::<i>Testing</i>::<i>MyTestHook</i>.</p></li> </ul><note>  <p>The following organization namespaces are reserved and can't be used in your extension names:</p>  <ul>   <li>    <p><code>Alexa</code></p></li>   <li>    <p><code>AMZN</code></p></li>   <li>    <p><code>Amazon</code></p></li>   <li>    <p><code>AWS</code></p></li>   <li>    <p><code>Custom</code></p></li>   <li>    <p><code>Dev</code></p></li>  </ul> </note><br>
    ///   - [`schema_handler_package(impl Into<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::schema_handler_package) / [`set_schema_handler_package(Option<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_schema_handler_package):<br>required: **true**<br><p>A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.</p> <p>For information about generating a schema handler package for the extension you want to register, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html">submit</a> in the <i>CloudFormation CLI User Guide</i>.</p><note>  <p>The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> permissions for the schema handler package. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>Identity and Access Management User Guide</i>.</p> </note><br>
    ///   - [`logging_config(LoggingConfig)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::logging_config) / [`set_logging_config(Option<LoggingConfig>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_logging_config):<br>required: **false**<br><p>Specifies logging configuration information for an extension.</p><br>
    ///   - [`execution_role_arn(impl Into<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::execution_role_arn) / [`set_execution_role_arn(Option<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_execution_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.</p> <p>For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principal (<code>resources.cloudformation.amazonaws.com</code>). For more information about adding trust relationships, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-console.html#roles-managingrole_edit-trust-policy">Modifying a role trust policy</a> in the <i>Identity and Access Management User Guide</i>.</p> <p>If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <i> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM execution role</a> </i> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::register_type::builders::RegisterTypeFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registration request, even if the request is submitted multiple times.</p><br>
    /// - On success, responds with [`RegisterTypeOutput`](crate::operation::register_type::RegisterTypeOutput) with field(s):
    ///   - [`registration_token(Option<String>)`](crate::operation::register_type::RegisterTypeOutput::registration_token): <p>The identifier for this registration request.</p> <p>Use this registration token when calling <code>DescribeTypeRegistration</code>, which returns information about the status and IDs of the extension registration.</p>
    /// - On failure, responds with [`SdkError<RegisterTypeError>`](crate::operation::register_type::RegisterTypeError)
    pub fn register_type(&self) -> crate::operation::register_type::builders::RegisterTypeFluentBuilder {
        crate::operation::register_type::builders::RegisterTypeFluentBuilder::new(self.handle.clone())
    }
}