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

Class: Aws::ServiceCatalog::Types::CreateProvisionedProductPlanInput

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

{
  accept_language: "AcceptLanguage",
  plan_name: "ProvisionedProductPlanName", # required
  plan_type: "CLOUDFORMATION", # required, accepts CLOUDFORMATION
  notification_arns: ["NotificationArn"],
  path_id: "Id",
  product_id: "Id", # required
  provisioned_product_name: "ProvisionedProductName", # required
  provisioning_artifact_id: "Id", # required
  provisioning_parameters: [
    {
      key: "ParameterKey",
      value: "ParameterValue",
      use_previous_value: false,
    },
  ],
  idempotency_token: "IdempotencyToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#idempotency_tokenString

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#notification_arnsArray<String>

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

Returns:

  • (Array<String>)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  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.

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#plan_nameString

The name of the plan.

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#plan_typeString

The plan type.

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#product_idString

The product identifier.

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  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)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#provisioning_artifact_idString

The identifier of the provisioning artifact.

Returns:

  • (String)


810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#provisioning_parametersArray<Types::UpdateProvisioningParameter>

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



810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tags.

Returns:



810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 810

class CreateProvisionedProductPlanInput < Struct.new(
  :accept_language,
  :plan_name,
  :plan_type,
  :notification_arns,
  :path_id,
  :product_id,
  :provisioned_product_name,
  :provisioning_artifact_id,
  :provisioning_parameters,
  :idempotency_token,
  :tags)
  include Aws::Structure
end