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

Interface DescribeTypeResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CloudFormationResponse.Builder, CopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>, SdkBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeTypeResponse
@Mutable @NotThreadSafe public static interface DescribeTypeResponse.Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeTypeResponse.Builder,DescribeTypeResponse>

  • Method Details

    • arn

      DescribeTypeResponse.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the extension.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      DescribeTypeResponse.Builder type(String type)

      The kind of extension.

      Parameters:
      type - The kind of extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      DescribeTypeResponse.Builder type(RegistryType type)

      The kind of extension.

      Parameters:
      type - The kind of extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typeName

      DescribeTypeResponse.Builder typeName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultVersionId

      DescribeTypeResponse.Builder defaultVersionId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • isDefaultVersion

      DescribeTypeResponse.Builder isDefaultVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • typeTestsStatus

      DescribeTypeResponse.Builder typeTestsStatus(String 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 (CLI) 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.

      Parameters:
      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 (CLI) 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typeTestsStatus

      DescribeTypeResponse.Builder typeTestsStatus(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 (CLI) 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.

      Parameters:
      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 (CLI) 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typeTestsStatusDescription

      DescribeTypeResponse.Builder typeTestsStatusDescription(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      DescribeTypeResponse.Builder description(String description)

      The description of the extension.

      Parameters:
      description - The description of the extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      DescribeTypeResponse.Builder schema(String schema)

      The schema that defines the extension.

      For more information, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.

      Parameters:
      schema - The schema that defines the extension.

      For more information, see Resource type schema in the CloudFormation Command Line Interface (CLI) User Guide and the CloudFormation Hooks User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • provisioningType

      DescribeTypeResponse.Builder provisioningType(String 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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • provisioningType

      DescribeTypeResponse.Builder provisioningType(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deprecatedStatus

      DescribeTypeResponse.Builder deprecatedStatus(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deprecatedStatus

      DescribeTypeResponse.Builder deprecatedStatus(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingConfig

      DescribeTypeResponse.Builder loggingConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfig

      default DescribeTypeResponse.Builder loggingConfig(Consumer<LoggingConfig.Builder> 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.

      This is a convenience method that creates an instance of the LoggingConfig.Builder avoiding the need to create one manually via LoggingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfig(LoggingConfig).

      Parameters:
      loggingConfig - a consumer that will call methods on LoggingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiredActivatedTypes

      DescribeTypeResponse.Builder requiredActivatedTypes(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredActivatedTypes

      DescribeTypeResponse.Builder requiredActivatedTypes(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredActivatedTypes

      DescribeTypeResponse.Builder requiredActivatedTypes(Consumer<RequiredActivatedType.Builder>... 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.

      This is a convenience method that creates an instance of the RequiredActivatedType.Builder avoiding the need to create one manually via RequiredActivatedType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requiredActivatedTypes(List<RequiredActivatedType>).

      Parameters:
      requiredActivatedTypes - a consumer that will call methods on RequiredActivatedType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionRoleArn

      DescribeTypeResponse.Builder executionRoleArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • visibility

      DescribeTypeResponse.Builder visibility(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibility

      DescribeTypeResponse.Builder visibility(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceUrl

      DescribeTypeResponse.Builder sourceUrl(String sourceUrl)

      The URL of the source code for the extension.

      Parameters:
      sourceUrl - The URL of the source code for the extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentationUrl

      DescribeTypeResponse.Builder documentationUrl(String documentationUrl)

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

      Parameters:
      documentationUrl - The URL of a page providing detailed documentation for this extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdated

      DescribeTypeResponse.Builder lastUpdated(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timeCreated

      DescribeTypeResponse.Builder timeCreated(Instant timeCreated)

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

      Parameters:
      timeCreated - When the specified private extension version was registered or activated in your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationSchema

      DescribeTypeResponse.Builder configurationSchema(String configurationSchema)

      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.

      Parameters:
      configurationSchema - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publisherId

      DescribeTypeResponse.Builder publisherId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • originalTypeName

      DescribeTypeResponse.Builder originalTypeName(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 Use aliases to refer to extensions in the CloudFormation User Guide.

      Parameters:
      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 Use aliases to refer to extensions in the CloudFormation User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originalTypeArn

      DescribeTypeResponse.Builder originalTypeArn(String originalTypeArn)

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

      Parameters:
      originalTypeArn - For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of the public extension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicVersionNumber

      DescribeTypeResponse.Builder publicVersionNumber(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • latestPublicVersion

      DescribeTypeResponse.Builder latestPublicVersion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • isActivated

      DescribeTypeResponse.Builder isActivated(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • autoUpdate

      DescribeTypeResponse.Builder autoUpdate(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 Automatically use new versions of extensions in the CloudFormation User Guide.

      Parameters:
      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 Automatically use new versions of extensions in the CloudFormation User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.