Package software.amazon.awssdk.services.cloudformation.model

Class DescribeTypeResponse

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the extension.

        Returns:
        The Amazon Resource Name (ARN) of the extension.

      • typeAsString

        public final String typeAsString()

        The kind of extension.

        If the service returns an enum value that is not available in the current SDK version, type will return RegistryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The kind of extension.
        See Also:
        RegistryType

      • typeName

        public final String typeName()

        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.

        Returns:
        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.

      • defaultVersionId

        public final String defaultVersionId()

        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.

        Returns:
        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.

      • isDefaultVersion

        public final Boolean isDefaultVersion()

        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.

        Returns:
        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.

      • typeTestsStatus

        public final TypeTestsStatus typeTestsStatus()

        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.

        If the service returns an enum value that is not available in the current SDK version, typeTestsStatus will return TypeTestsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeTestsStatusAsString().

        Returns:
        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.

        See Also:
        TypeTestsStatus

      • typeTestsStatusAsString

        public final String typeTestsStatusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, typeTestsStatus will return TypeTestsStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeTestsStatusAsString().

        Returns:
        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.

        See Also:
        TypeTestsStatus

      • typeTestsStatusDescription

        public final String typeTestsStatusDescription()

        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.

        Returns:
        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.

      • description

        public final String description()

        The description of the extension.

        Returns:
        The description of the extension.

      • schema

        public final String schema()

        The schema that defines the extension.

        For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

        Returns:
        The schema that defines the extension.

        For more information about extension schemas, see Resource Provider Schema in the CloudFormation CLI User Guide.

      • provisioningType

        public final ProvisioningType provisioningType()

        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

        If the service returns an enum value that is not available in the current SDK version, provisioningType will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningTypeAsString().

        Returns:
        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

        See Also:
        ProvisioningType

      • provisioningTypeAsString

        public final String provisioningTypeAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, provisioningType will return ProvisioningType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningTypeAsString().

        Returns:
        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

        See Also:
        ProvisioningType

      • deprecatedStatus

        public final DeprecatedStatus deprecatedStatus()

        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.

        If the service returns an enum value that is not available in the current SDK version, deprecatedStatus will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deprecatedStatusAsString().

        Returns:
        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.

        See Also:
        DeprecatedStatus

      • deprecatedStatusAsString

        public final String deprecatedStatusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, deprecatedStatus will return DeprecatedStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deprecatedStatusAsString().

        Returns:
        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.

        See Also:
        DeprecatedStatus

      • loggingConfig

        public final LoggingConfig loggingConfig()

        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.

        Returns:
        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.

      • hasRequiredActivatedTypes

        public final boolean hasRequiredActivatedTypes()
        For responses, this returns true if the service returned a value for the RequiredActivatedTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • requiredActivatedTypes

        public final List<RequiredActivatedType> requiredActivatedTypes()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredActivatedTypes() method.

        Returns:
        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.

      • executionRoleArn

        public final String executionRoleArn()

        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.

        Returns:
        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.

      • visibility

        public final Visibility visibility()

        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 as PRIVATE.

        • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        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 as PRIVATE.

        • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

        See Also:
        Visibility

      • visibilityAsString

        public final String visibilityAsString()

        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 as PRIVATE.

        • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        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 as PRIVATE.

        • PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.

        See Also:
        Visibility

      • sourceUrl

        public final String sourceUrl()

        The URL of the source code for the extension.

        Returns:
        The URL of the source code for the extension.

      • documentationUrl

        public final String documentationUrl()

        The URL of a page providing detailed documentation for this extension.

        Returns:
        The URL of a page providing detailed documentation for this extension.

      • lastUpdated

        public final Instant lastUpdated()

        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.

        Returns:
        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.

      • timeCreated

        public final Instant timeCreated()

        When the specified private extension version was registered or activated in your account.

        Returns:
        When the specified private extension version was registered or activated in your account.

      • publisherId

        public final String publisherId()

        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.

        Returns:
        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.

      • originalTypeName

        public final String originalTypeName()

        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.

        Returns:
        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.

      • originalTypeArn

        public final String originalTypeArn()

        For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

        Returns:
        For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.

      • publicVersionNumber

        public final String publicVersionNumber()

        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.

        Returns:
        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.

      • latestPublicVersion

        public final String latestPublicVersion()

        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.

        Returns:
        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.

      • isActivated

        public final Boolean isActivated()

        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.

        Returns:
        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.

      • autoUpdate

        public final Boolean autoUpdate()

        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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object