Class: Aws::ServiceCatalog::Types::ProvisionProductInput

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::ProvisionProductInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

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

{
  accept_language: "AcceptLanguage",
  product_id: "Id",
  product_name: "ProductViewName",
  provisioning_artifact_id: "Id",
  provisioning_artifact_name: "ProvisioningArtifactName",
  path_id: "Id",
  path_name: "PortfolioDisplayName",
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
    },
  ],
  provisioning_preferences: {
    stack_set_accounts: ["AccountId"],
    stack_set_regions: ["Region"],
    stack_set_failure_tolerance_count: 1,
    stack_set_failure_tolerance_percentage: 1,
    stack_set_max_concurrency_count: 1,
    stack_set_max_concurrency_percentage: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notification_arns: ["NotificationArn"],
  provision_token: "IdempotencyToken", # required
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accept_language ⇒ String

  The language code.

• #notification_arns ⇒ Array<String>

  Passed to CloudFormation.

• #path_id ⇒ String

  The path identifier of the product.

• #path_name ⇒ String

  The name of the path.

• #product_id ⇒ String

  The product identifier.

• #product_name ⇒ String

  The name of the product.

• #provision_token ⇒ String

  An idempotency token that uniquely identifies the provisioning request.

• #provisioned_product_name ⇒ String

  A user-friendly name for the provisioned product.

• #provisioning_artifact_id ⇒ String

  The identifier of the provisioning artifact.

• #provisioning_artifact_name ⇒ String

  The name of the provisioning artifact.

• #provisioning_parameters ⇒ Array<Types::ProvisioningParameter>

  Parameters specified by the administrator that are required for provisioning the product.

• #provisioning_preferences ⇒ Types::ProvisioningPreferences

  An object that contains information about the provisioning preferences for a stack set.

• #tags ⇒ Array<Types::Tag>

  One or more tags.

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 5216

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#notification_arns ⇒ Array<String>

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

Returns:

• (Array<String>)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#path_id ⇒ String

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#path_name ⇒ String

The name of the path. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#product_id ⇒ String

The product identifier. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#product_name ⇒ String

The name of the product. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provision_token ⇒ String

An idempotency token that uniquely identifies the provisioning request.

**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 5216

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_product_name ⇒ String

A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_artifact_id ⇒ String

The identifier of the provisioning artifact. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_artifact_name ⇒ String

The name of the provisioning artifact. You must provide the name or ID, but not both.

Returns:

• (String)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_parameters ⇒ Array<Types::ProvisioningParameter>

Parameters specified by the administrator that are required for provisioning the product.

Returns:

• (Array<Types::ProvisioningParameter>)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#provisioning_preferences ⇒ Types::ProvisioningPreferences

An object that contains information about the provisioning preferences for a stack set.

Returns:

• (Types::ProvisioningPreferences)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

One or more tags.

Returns:

• (Array<Types::Tag>)

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

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :product_name,
  :provisioning_artifact_id,
  :provisioning_artifact_name,
  :path_id,
  :path_name,
  :provisioned_product_name,
  :provisioning_parameters,
  :provisioning_preferences,
  :tags,
  :notification_arns,
  :provision_token)
  SENSITIVE = []
  include Aws::Structure
end