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",
  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
}

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)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_arnsArray<String>

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

Returns:

  • (Array<String>)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_idString

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)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_nameString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_idString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_nameString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_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)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_nameString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_idString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_nameString

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

Returns:

  • (String)


5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_parametersArray<Types::ProvisioningParameter>

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

Returns:



5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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_preferencesTypes::ProvisioningPreferences

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



5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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

#tagsArray<Types::Tag>

One or more tags.

Returns:



5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 5038

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