You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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 ProvisionProductInput data as a hash:

{
  accept_language: "AcceptLanguage",
  product_id: "Id", # required
  provisioning_artifact_id: "Id", # required
  path_id: "Id",
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  notification_arns: ["NotificationArn"],
  provision_token: "IdempotencyToken", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

Returns:

  • (String)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#notification_arnsArray<String>

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

Returns:

  • (Array<String>)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#path_idString

The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

Returns:

  • (String)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#product_idString

The product identifier.

Returns:

  • (String)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#provision_tokenString

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)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#provisioned_product_nameString

A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

Returns:

  • (String)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#provisioning_artifact_idString

The provisioning artifact identifier for this product. This is sometimes referred to as the product version.

Returns:

  • (String)


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#provisioning_parametersArray<Types::ProvisioningParameter>

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

Returns:



2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to use as provisioning options.

Returns:



2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 2642

class ProvisionProductInput < Struct.new(
  :accept_language,
  :product_id,
  :provisioning_artifact_id,
  :path_id,
  :provisioned_product_name,
  :provisioning_parameters,
  :tags,
  :notification_arns,
  :provision_token)
  include Aws::Structure
end