Struct aws_sdk_cloudformation::input::RegisterTypeInput

#[non_exhaustive]
pub struct RegisterTypeInput {
    pub type: Option<RegistryType>,
    pub type_name: Option<String>,
    pub schema_handler_package: Option<String>,
    pub logging_config: Option<LoggingConfig>,
    pub execution_role_arn: Option<String>,
    pub client_request_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Option<RegistryType>

The kind of extension.

type_name: Option<String>

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

schema_handler_package: Option<String>

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

logging_config: Option<LoggingConfig>

Specifies logging configuration information for an extension.

execution_role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role 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.

client_request_token: Option<String>

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.

Implementations

impl RegisterTypeInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<RegisterType, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<RegisterType>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RegisterTypeInput

impl RegisterTypeInput

pub fn type(&self) -> Option<&RegistryType>

The kind of extension.

pub fn type_name(&self) -> Option<&str>

The name of the extension being registered.

We suggest that extension names adhere to the following patterns:

• For resource types, company_or_organization::service::type.

• For modules, company_or_organization::service::type::MODULE.

• For hooks, MyCompany::Testing::MyTestHook.

The following organization namespaces are reserved and can't be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

pub fn schema_handler_package(&self) -> Option<&str>

A URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register.

For information about generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

pub fn logging_config(&self) -> Option<&LoggingConfig>

Specifies logging configuration information for an extension.

pub fn execution_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information about adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an IAM execution role 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.

pub fn client_request_token(&self) -> Option<&str>

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.

Trait Implementations

impl Clone for RegisterTypeInput

fn clone(&self) -> RegisterTypeInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegisterTypeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RegisterTypeInput> for RegisterTypeInput

fn eq(&self, other: &RegisterTypeInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RegisterTypeInput) -> bool

This method tests for !=.

impl StructuralPartialEq for RegisterTypeInput