Struct aws_sdk_cloudformation::operation::list_types::ListTypesInput

#[non_exhaustive]
pub struct ListTypesInput {
    pub visibility: Option<Visibility>,
    pub provisioning_type: Option<ProvisioningType>,
    pub deprecated_status: Option<DeprecatedStatus>,
    pub type: Option<RegistryType>,
    pub filters: Option<TypeFilters>,
    pub max_results: Option<i32>,
    pub next_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.

visibility: Option<Visibility>

The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

  • Private extensions you have registered in this account and Region.

  • Public extensions that you have activated in this account and Region.

• PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

provisioning_type: Option<ProvisioningType>

For resource types, 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 create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

deprecated_status: Option<DeprecatedStatus>

The deprecation status of the extension that you want to get summary information about.

Valid values include:

• LIVE: The extension is registered for use in CloudFormation operations.

• DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

type: Option<RegistryType>

The type of extension.

filters: Option<TypeFilters>

Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

max_results: Option<i32>

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

next_token: Option<String>

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Implementations

impl ListTypesInput

pub fn visibility(&self) -> Option<&Visibility>

The scope at which the extensions are visible and usable in CloudFormation operations.

Valid values include:

• PRIVATE: Extensions that are visible and usable within this account and Region. This includes:

  • Private extensions you have registered in this account and Region.

  • Public extensions that you have activated in this account and Region.

• PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

The default is PRIVATE.

pub fn provisioning_type(&self) -> Option<&ProvisioningType>

For resource types, 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 create, read, and delete handlers, and therefore can't actually be provisioned.

The default is FULLY_MUTABLE.

pub fn deprecated_status(&self) -> Option<&DeprecatedStatus>

The deprecation status of the extension that you want to get summary information about.

Valid values include:

• LIVE: The extension is registered for use in CloudFormation operations.

• DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

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

The type of extension.

pub fn filters(&self) -> Option<&TypeFilters>

Filter criteria to use in determining which extensions to return.

Filters must be compatible with Visibility to return valid results. For example, specifying AWS_TYPES for Category and PRIVATE for Visibility returns an empty list of types, but specifying PUBLIC for Visibility returns the desired list.

pub fn max_results(&self) -> Option<i32>

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

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

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

impl ListTypesInput

pub fn builder() -> ListTypesInputBuilder

Creates a new builder-style object to manufacture ListTypesInput.

Trait Implementations

impl Clone for ListTypesInput

fn clone(&self) -> ListTypesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListTypesInput

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

Formats the value using the given formatter.

impl PartialEq for ListTypesInput

fn eq(&self, other: &ListTypesInput) -> 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 ListTypesInput