Struct aws_sdk_cloudformation::client::fluent_builders::RegisterType

pub struct RegisterType<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to RegisterType.

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

• Validating the extension schema

• Determining which handlers, if any, have been specified for the extension

• Making the extension available for use in your account

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Implementations

impl<C, M, R> RegisterType<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<RegisterTypeOutput, SdkError<RegisterTypeError>> where
    R::Policy: SmithyRetryPolicy<RegisterTypeInputOperationOutputAlias, RegisterTypeOutput, RegisterTypeError, RegisterTypeInputOperationRetryAlias>, 

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, which can be set when configuring the client.

pub fn type(self, inp: RegistryType) -> Self

The kind of extension.

pub fn set_type(self, input: Option<RegistryType>) -> Self

The kind of extension.

pub fn type_name(self, inp: impl Into<String>) -> Self

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

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

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

The following organization namespaces are reserved and cannot be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

pub fn set_type_name(self, input: Option<String>) -> Self

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

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

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

The following organization namespaces are reserved and cannot be used in your extension names:

• Alexa

• AMZN

• Amazon

• AWS

• Custom

• Dev

pub fn schema_handler_package(self, inp: impl Into<String>) -> Self

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

For information on 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 is, 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 set_schema_handler_package(self, input: Option<String>) -> Self

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

For information on 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 is, 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, inp: LoggingConfig) -> Self

Specifies logging configuration information for an extension.

pub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self

Specifies logging configuration information for an extension.

pub fn execution_role_arn(self, inp: impl Into<String>) -> Self

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 on 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 set_execution_role_arn(self, input: Option<String>) -> Self

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 on 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, inp: impl Into<String>) -> Self

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 registeration request, even if the request is submitted multiple times.

pub fn set_client_request_token(self, input: Option<String>) -> Self

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 registeration request, even if the request is submitted multiple times.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for RegisterType<C, M, R>

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

Formats the value using the given formatter.