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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-servicecatalog/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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Returns:

  • (String)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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_errorsBoolean

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

Returns:

  • (Boolean)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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_idString

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

Returns:

  • (String)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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_nameString

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

Returns:

  • (String)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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_resourcesBoolean

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)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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_tokenString

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)


7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
# File 'gems/aws-sdk-servicecatalog/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