Struct aws_sdk_cloudformation::operation::register_type::builders::RegisterTypeInputBuilder

#[non_exhaustive]
pub struct RegisterTypeInputBuilder { /* private fields */ }

A builder for RegisterTypeInput.

Implementations

impl RegisterTypeInputBuilder

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

The kind of extension.

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

The kind of extension.

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

The kind of extension.

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

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

This field is required.

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

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 get_type_name(&self) -> &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

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

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.

This field is required.

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 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 get_schema_handler_package(&self) -> &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.

pub fn logging_config(self, input: 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 get_logging_config(&self) -> &Option<LoggingConfig>

Specifies logging configuration information for an extension.

pub fn execution_role_arn(self, input: 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 principal (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 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 principal (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 get_execution_role_arn(&self) -> &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 principal (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, input: 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 registration 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 registration request, even if the request is submitted multiple times.

pub fn get_client_request_token(&self) -> &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.

pub fn build(self) -> Result<RegisterTypeInput, BuildError>

Consumes the builder and constructs a RegisterTypeInput.

impl RegisterTypeInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<RegisterTypeOutput, SdkError<RegisterTypeError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for RegisterTypeInputBuilder

fn clone(&self) -> RegisterTypeInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterTypeInputBuilder

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

Formats the value using the given formatter.

impl Default for RegisterTypeInputBuilder

fn default() -> RegisterTypeInputBuilder

Returns the “default value” for a type.

impl PartialEq for RegisterTypeInputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RegisterTypeInputBuilder