Struct aws_sdk_cloudformation::output::describe_type_output::Builder
source · [−]#[non_exhaustive]pub struct Builder { /* private fields */ }
Expand description
A builder for DescribeTypeOutput
Implementations
sourceimpl Builder
impl Builder
sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the extension.
sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the extension.
sourcepub fn type(self, input: RegistryType) -> Self
pub fn type(self, input: RegistryType) -> Self
The kind of extension.
sourcepub fn set_type(self, input: Option<RegistryType>) -> Self
pub fn set_type(self, input: Option<RegistryType>) -> Self
The kind of extension.
sourcepub fn type_name(self, input: impl Into<String>) -> Self
pub fn type_name(self, input: impl Into<String>) -> Self
The name of the extension.
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.
sourcepub fn set_type_name(self, input: Option<String>) -> Self
pub fn set_type_name(self, input: Option<String>) -> Self
The name of the extension.
If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the type name alias. For more information, see ActivateType.
sourcepub fn default_version_id(self, input: impl Into<String>) -> Self
pub fn default_version_id(self, input: impl Into<String>) -> Self
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use
.SetTypeDefaultVersion
sourcepub fn set_default_version_id(self, input: Option<String>) -> Self
pub fn set_default_version_id(self, input: Option<String>) -> Self
The ID of the default version of the extension. The default version is used when the extension version isn't specified.
This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
To set the default version of an extension, use
.SetTypeDefaultVersion
sourcepub fn is_default_version(self, input: bool) -> Self
pub fn is_default_version(self, input: bool) -> Self
Whether the specified extension version is set as the default version.
This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null
.
sourcepub fn set_is_default_version(self, input: Option<bool>) -> Self
pub fn set_is_default_version(self, input: Option<bool>) -> Self
Whether the specified extension version is set as the default version.
This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns null
.
sourcepub fn type_tests_status(self, input: TypeTestsStatus) -> Self
pub fn type_tests_status(self, input: TypeTestsStatus) -> Self
The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
-
PASSED
: The extension has passed all its contract tests.An extension must have a test status of
PASSED
before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide. -
FAILED
: The extension has failed one or more contract tests. -
IN_PROGRESS
: Contract tests are currently being performed on the extension. -
NOT_TESTED
: Contract tests haven't been performed on the extension.
sourcepub fn set_type_tests_status(self, input: Option<TypeTestsStatus>) -> Self
pub fn set_type_tests_status(self, input: Option<TypeTestsStatus>) -> Self
The contract test status of the registered extension version. To return the extension test status of a specific extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
-
PASSED
: The extension has passed all its contract tests.An extension must have a test status of
PASSED
before it can be published. For more information, see Publishing extensions to make them available for public use in the CloudFormation Command Line Interface User Guide. -
FAILED
: The extension has failed one or more contract tests. -
IN_PROGRESS
: Contract tests are currently being performed on the extension. -
NOT_TESTED
: Contract tests haven't been performed on the extension.
sourcepub fn type_tests_status_description(self, input: impl Into<String>) -> Self
pub fn type_tests_status_description(self, input: impl Into<String>) -> Self
The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
sourcepub fn set_type_tests_status_description(self, input: Option<String>) -> Self
pub fn set_type_tests_status_description(self, input: Option<String>) -> Self
The description of the test status. To return the extension test status of a specific extension version, you must specify VersionId
.
This applies only to registered private extension versions. CloudFormation doesn't return this information for public extensions, whether they are activated in your account.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the extension.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the extension.
sourcepub fn schema(self, input: impl Into<String>) -> Self
pub fn schema(self, input: impl Into<String>) -> Self
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
sourcepub fn set_schema(self, input: Option<String>) -> Self
pub fn set_schema(self, input: Option<String>) -> Self
The schema that defines the extension.
For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.
sourcepub fn provisioning_type(self, input: ProvisioningType) -> Self
pub fn provisioning_type(self, input: ProvisioningType) -> Self
For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
Valid values include:
-
FULLY_MUTABLE
: The resource type includes an update handler to process updates to the type during stack update operations. -
IMMUTABLE
: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations. -
NON_PROVISIONABLE
: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.-
create
-
read
-
delete
-
sourcepub fn set_provisioning_type(self, input: Option<ProvisioningType>) -> Self
pub fn set_provisioning_type(self, input: Option<ProvisioningType>) -> Self
For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
Valid values include:
-
FULLY_MUTABLE
: The resource type includes an update handler to process updates to the type during stack update operations. -
IMMUTABLE
: The resource type doesn't include an update handler, so the type can't be updated and must instead be replaced during stack update operations. -
NON_PROVISIONABLE
: The resource type doesn't include all the following handlers, and therefore can't actually be provisioned.-
create
-
read
-
delete
-
sourcepub fn deprecated_status(self, input: DeprecatedStatus) -> Self
pub fn deprecated_status(self, input: DeprecatedStatus) -> Self
The deprecation status of the extension version.
Valid values include:
-
LIVE
: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. -
DEPRECATED
: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns null
.
sourcepub fn set_deprecated_status(self, input: Option<DeprecatedStatus>) -> Self
pub fn set_deprecated_status(self, input: Option<DeprecatedStatus>) -> Self
The deprecation status of the extension version.
Valid values include:
-
LIVE
: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope. -
DEPRECATED
: The extension has been deactivated or deregistered and can no longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns null
.
sourcepub fn logging_config(self, input: LoggingConfig) -> Self
pub fn logging_config(self, input: LoggingConfig) -> Self
Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
sourcepub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
pub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
Contains logging configuration information for private extensions. This applies only to private extensions you have registered in your account. For public extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null
. For more information, see RegisterType.
sourcepub fn required_activated_types(self, input: RequiredActivatedType) -> Self
pub fn required_activated_types(self, input: RequiredActivatedType) -> Self
Appends an item to required_activated_types
.
To override the contents of this collection use set_required_activated_types
.
For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.
sourcepub fn set_required_activated_types(
self,
input: Option<Vec<RequiredActivatedType>>
) -> Self
pub fn set_required_activated_types(
self,
input: Option<Vec<RequiredActivatedType>>
) -> Self
For extensions that are modules, the public third-party extensions that must be activated in your account in order for the module itself to be activated.
sourcepub fn execution_role_arn(self, input: impl Into<String>) -> Self
pub fn execution_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.
If the registered extension calls any Amazon Web Services APIs, 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. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
sourcepub fn set_execution_role_arn(self, input: Option<String>) -> Self
pub fn set_execution_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to private extensions you have registered in your account. For more information, see RegisterType.
If the registered extension calls any Amazon Web Services APIs, 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. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.
sourcepub fn visibility(self, input: Visibility) -> Self
pub fn visibility(self, input: Visibility) -> Self
The scope at which the extension is visible and usable in CloudFormation operations.
Valid values include:
-
PRIVATE
: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register asPRIVATE
. -
PUBLIC
: The extension is publicly visible and usable within any Amazon Web Services account.
sourcepub fn set_visibility(self, input: Option<Visibility>) -> Self
pub fn set_visibility(self, input: Option<Visibility>) -> Self
The scope at which the extension is visible and usable in CloudFormation operations.
Valid values include:
-
PRIVATE
: The extension is only visible and usable within the account in which it is registered. CloudFormation marks any extensions you register asPRIVATE
. -
PUBLIC
: The extension is publicly visible and usable within any Amazon Web Services account.
sourcepub fn source_url(self, input: impl Into<String>) -> Self
pub fn source_url(self, input: impl Into<String>) -> Self
The URL of the source code for the extension.
sourcepub fn set_source_url(self, input: Option<String>) -> Self
pub fn set_source_url(self, input: Option<String>) -> Self
The URL of the source code for the extension.
sourcepub fn documentation_url(self, input: impl Into<String>) -> Self
pub fn documentation_url(self, input: impl Into<String>) -> Self
The URL of a page providing detailed documentation for this extension.
sourcepub fn set_documentation_url(self, input: Option<String>) -> Self
pub fn set_documentation_url(self, input: Option<String>) -> Self
The URL of a page providing detailed documentation for this extension.
sourcepub fn last_updated(self, input: DateTime) -> Self
pub fn last_updated(self, input: DateTime) -> Self
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
sourcepub fn set_last_updated(self, input: Option<DateTime>) -> Self
pub fn set_last_updated(self, input: Option<DateTime>) -> Self
When the specified extension version was registered. This applies only to:
-
Private extensions you have registered in your account. For more information, see RegisterType.
-
Public extensions you have activated in your account with auto-update specified. For more information, see ActivateType.
sourcepub fn time_created(self, input: DateTime) -> Self
pub fn time_created(self, input: DateTime) -> Self
When the specified private extension version was registered or activated in your account.
sourcepub fn set_time_created(self, input: Option<DateTime>) -> Self
pub fn set_time_created(self, input: Option<DateTime>) -> Self
When the specified private extension version was registered or activated in your account.
sourcepub fn configuration_schema(self, input: impl Into<String>) -> Self
pub fn configuration_schema(self, input: impl Into<String>) -> Self
A JSON string that represent the current configuration data for the extension in this account and region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
sourcepub fn set_configuration_schema(self, input: Option<String>) -> Self
pub fn set_configuration_schema(self, input: Option<String>) -> Self
A JSON string that represent the current configuration data for the extension in this account and region.
To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
sourcepub fn publisher_id(self, input: impl Into<String>) -> Self
pub fn publisher_id(self, input: impl Into<String>) -> Self
The publisher ID of the extension publisher.
This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null
.
sourcepub fn set_publisher_id(self, input: Option<String>) -> Self
pub fn set_publisher_id(self, input: Option<String>) -> Self
The publisher ID of the extension publisher.
This applies only to public third-party extensions. For private registered extensions, and extensions provided by Amazon Web Services, CloudFormation returns null
.
sourcepub fn original_type_name(self, input: impl Into<String>) -> Self
pub fn original_type_name(self, input: impl Into<String>) -> Self
For public extensions that have been activated for this account and region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
sourcepub fn set_original_type_name(self, input: Option<String>) -> Self
pub fn set_original_type_name(self, input: Option<String>) -> Self
For public extensions that have been activated for this account and region, the type name of the public extension.
If you specified a TypeNameAlias
when enabling the extension in this account and region, CloudFormation treats that alias as the extension's type name within the account and region, not the type name of the public extension. For more information, see Specifying aliases to refer to extensions in the CloudFormation User Guide.
sourcepub fn original_type_arn(self, input: impl Into<String>) -> Self
pub fn original_type_arn(self, input: impl Into<String>) -> Self
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.
sourcepub fn set_original_type_arn(self, input: Option<String>) -> Self
pub fn set_original_type_arn(self, input: Option<String>) -> Self
For public extensions that have been activated for this account and region, the Amazon Resource Name (ARN) of the public extension.
sourcepub fn public_version_number(self, input: impl Into<String>) -> Self
pub fn public_version_number(self, input: impl Into<String>) -> Self
The version number of a public third-party extension.
This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null
.
sourcepub fn set_public_version_number(self, input: Option<String>) -> Self
pub fn set_public_version_number(self, input: Option<String>) -> Self
The version number of a public third-party extension.
This applies only if you specify a public extension you have activated in your account, or specify a public extension without specifying a version. For all other extensions, CloudFormation returns null
.
sourcepub fn latest_public_version(self, input: impl Into<String>) -> Self
pub fn latest_public_version(self, input: impl Into<String>) -> Self
The latest version of a public extension that is available for use.
This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null
.
sourcepub fn set_latest_public_version(self, input: Option<String>) -> Self
pub fn set_latest_public_version(self, input: Option<String>) -> Self
The latest version of a public extension that is available for use.
This only applies if you specify a public extension, and you don't specify a version. For all other requests, CloudFormation returns null
.
sourcepub fn is_activated(self, input: bool) -> Self
pub fn is_activated(self, input: bool) -> Self
Whether the extension is activated in the account and region.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
sourcepub fn set_is_activated(self, input: Option<bool>) -> Self
pub fn set_is_activated(self, input: Option<bool>) -> Self
Whether the extension is activated in the account and region.
This only applies to public third-party extensions. For all other extensions, CloudFormation returns null
.
sourcepub fn auto_update(self, input: bool) -> Self
pub fn auto_update(self, input: bool) -> Self
Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.
sourcepub fn set_auto_update(self, input: Option<bool>) -> Self
pub fn set_auto_update(self, input: Option<bool>) -> Self
Whether CloudFormation automatically updates the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated. For more information, see Activating public extensions for use in your account in the CloudFormation User Guide.
sourcepub fn build(self) -> DescribeTypeOutput
pub fn build(self) -> DescribeTypeOutput
Consumes the builder and constructs a DescribeTypeOutput
Trait Implementations
impl StructuralPartialEq for Builder
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more