Class: Aws::ServiceCatalog::Types::TerminateProvisionedProductInput

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::TerminateProvisionedProductInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

When making an API call, you may pass TerminateProvisionedProductInput data as a hash:

{
  provisioned_product_name: "ProvisionedProductNameOrArn",
  provisioned_product_id: "Id",
  terminate_token: "IdempotencyToken", # required
  ignore_errors: false,
  accept_language: "AcceptLanguage",
  retain_physical_resources: false,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accept_language ⇒ String

  The language code.

• #ignore_errors ⇒ Boolean

  If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

• #provisioned_product_id ⇒ String

  The identifier of the provisioned product.

• #provisioned_product_name ⇒ String

  The name of the provisioned product.

• #retain_physical_resources ⇒ Boolean

  When this boolean parameter is set to true, the ‘TerminateProvisionedProduct` API deletes the Service Catalog provisioned product.

• #terminate_token ⇒ String

  An idempotency token that uniquely identifies the termination request.

Instance Attribute Details

#accept_language ⇒ String

The language code.

• ‘en` - English (default)

• ‘jp` - Japanese

• ‘zh` - Chinese

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end

#ignore_errors ⇒ Boolean

If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

Returns:

• (Boolean)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_product_id ⇒ String

The identifier of the provisioned product. You cannot specify both ‘ProvisionedProductName` and `ProvisionedProductId`.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_product_name ⇒ String

The name of the provisioned product. You cannot specify both ‘ProvisionedProductName` and `ProvisionedProductId`.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end

#retain_physical_resources ⇒ Boolean

When this boolean parameter is set to true, the ‘TerminateProvisionedProduct` API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

Returns:

• (Boolean)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_token ⇒ String

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 7278

class TerminateProvisionedProductInput < Struct.new(
  :provisioned_product_name,
  :provisioned_product_id,
  :terminate_token,
  :ignore_errors,
  :accept_language,
  :retain_physical_resources)
  SENSITIVE = []
  include Aws::Structure
end