aws.servicecatalog.ProvisionedProduct
Explore with Pulumi AI
This resource provisions and manages a Service Catalog provisioned product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources.
Like this resource, the aws_servicecatalog_record
data source also provides information about a provisioned product. Although a Service Catalog record provides some overlapping information with this resource, a record is tied to a provisioned product event, such as provisioning, termination, and updating.
Tip: If you include conflicted keys as tags, AWS will report an error, “Parameter validation failed: Missing required parameter in Tags[N]:Value”.
Tip: A “provisioning artifact” is also referred to as a “version.” A “distributor” is also referred to as a “vendor.”
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.servicecatalog.ProvisionedProduct("example", {
name: "example",
productName: "Example product",
provisioningArtifactName: "Example version",
provisioningParameters: [{
key: "foo",
value: "bar",
}],
tags: {
foo: "bar",
},
});
import pulumi
import pulumi_aws as aws
example = aws.servicecatalog.ProvisionedProduct("example",
name="example",
product_name="Example product",
provisioning_artifact_name="Example version",
provisioning_parameters=[{
"key": "foo",
"value": "bar",
}],
tags={
"foo": "bar",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/servicecatalog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := servicecatalog.NewProvisionedProduct(ctx, "example", &servicecatalog.ProvisionedProductArgs{
Name: pulumi.String("example"),
ProductName: pulumi.String("Example product"),
ProvisioningArtifactName: pulumi.String("Example version"),
ProvisioningParameters: servicecatalog.ProvisionedProductProvisioningParameterArray{
&servicecatalog.ProvisionedProductProvisioningParameterArgs{
Key: pulumi.String("foo"),
Value: pulumi.String("bar"),
},
},
Tags: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ServiceCatalog.ProvisionedProduct("example", new()
{
Name = "example",
ProductName = "Example product",
ProvisioningArtifactName = "Example version",
ProvisioningParameters = new[]
{
new Aws.ServiceCatalog.Inputs.ProvisionedProductProvisioningParameterArgs
{
Key = "foo",
Value = "bar",
},
},
Tags =
{
{ "foo", "bar" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicecatalog.ProvisionedProduct;
import com.pulumi.aws.servicecatalog.ProvisionedProductArgs;
import com.pulumi.aws.servicecatalog.inputs.ProvisionedProductProvisioningParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ProvisionedProduct("example", ProvisionedProductArgs.builder()
.name("example")
.productName("Example product")
.provisioningArtifactName("Example version")
.provisioningParameters(ProvisionedProductProvisioningParameterArgs.builder()
.key("foo")
.value("bar")
.build())
.tags(Map.of("foo", "bar"))
.build());
}
}
resources:
example:
type: aws:servicecatalog:ProvisionedProduct
properties:
name: example
productName: Example product
provisioningArtifactName: Example version
provisioningParameters:
- key: foo
value: bar
tags:
foo: bar
Create ProvisionedProduct Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProvisionedProduct(name: string, args?: ProvisionedProductArgs, opts?: CustomResourceOptions);
@overload
def ProvisionedProduct(resource_name: str,
args: Optional[ProvisionedProductArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ProvisionedProduct(resource_name: str,
opts: Optional[ResourceOptions] = None,
accept_language: Optional[str] = None,
ignore_errors: Optional[bool] = None,
name: Optional[str] = None,
notification_arns: Optional[Sequence[str]] = None,
path_id: Optional[str] = None,
path_name: Optional[str] = None,
product_id: Optional[str] = None,
product_name: Optional[str] = None,
provisioning_artifact_id: Optional[str] = None,
provisioning_artifact_name: Optional[str] = None,
provisioning_parameters: Optional[Sequence[ProvisionedProductProvisioningParameterArgs]] = None,
retain_physical_resources: Optional[bool] = None,
stack_set_provisioning_preferences: Optional[ProvisionedProductStackSetProvisioningPreferencesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewProvisionedProduct(ctx *Context, name string, args *ProvisionedProductArgs, opts ...ResourceOption) (*ProvisionedProduct, error)
public ProvisionedProduct(string name, ProvisionedProductArgs? args = null, CustomResourceOptions? opts = null)
public ProvisionedProduct(String name, ProvisionedProductArgs args)
public ProvisionedProduct(String name, ProvisionedProductArgs args, CustomResourceOptions options)
type: aws:servicecatalog:ProvisionedProduct
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ProvisionedProductArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProvisionedProductArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProvisionedProductArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProvisionedProductArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProvisionedProductArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var provisionedProductResource = new Aws.ServiceCatalog.ProvisionedProduct("provisionedProductResource", new()
{
AcceptLanguage = "string",
IgnoreErrors = false,
Name = "string",
NotificationArns = new[]
{
"string",
},
PathId = "string",
PathName = "string",
ProductId = "string",
ProductName = "string",
ProvisioningArtifactId = "string",
ProvisioningArtifactName = "string",
ProvisioningParameters = new[]
{
new Aws.ServiceCatalog.Inputs.ProvisionedProductProvisioningParameterArgs
{
Key = "string",
UsePreviousValue = false,
Value = "string",
},
},
RetainPhysicalResources = false,
StackSetProvisioningPreferences = new Aws.ServiceCatalog.Inputs.ProvisionedProductStackSetProvisioningPreferencesArgs
{
Accounts = new[]
{
"string",
},
FailureToleranceCount = 0,
FailureTolerancePercentage = 0,
MaxConcurrencyCount = 0,
MaxConcurrencyPercentage = 0,
Regions = new[]
{
"string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := servicecatalog.NewProvisionedProduct(ctx, "provisionedProductResource", &servicecatalog.ProvisionedProductArgs{
AcceptLanguage: pulumi.String("string"),
IgnoreErrors: pulumi.Bool(false),
Name: pulumi.String("string"),
NotificationArns: pulumi.StringArray{
pulumi.String("string"),
},
PathId: pulumi.String("string"),
PathName: pulumi.String("string"),
ProductId: pulumi.String("string"),
ProductName: pulumi.String("string"),
ProvisioningArtifactId: pulumi.String("string"),
ProvisioningArtifactName: pulumi.String("string"),
ProvisioningParameters: servicecatalog.ProvisionedProductProvisioningParameterArray{
&servicecatalog.ProvisionedProductProvisioningParameterArgs{
Key: pulumi.String("string"),
UsePreviousValue: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
RetainPhysicalResources: pulumi.Bool(false),
StackSetProvisioningPreferences: &servicecatalog.ProvisionedProductStackSetProvisioningPreferencesArgs{
Accounts: pulumi.StringArray{
pulumi.String("string"),
},
FailureToleranceCount: pulumi.Int(0),
FailureTolerancePercentage: pulumi.Int(0),
MaxConcurrencyCount: pulumi.Int(0),
MaxConcurrencyPercentage: pulumi.Int(0),
Regions: pulumi.StringArray{
pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var provisionedProductResource = new ProvisionedProduct("provisionedProductResource", ProvisionedProductArgs.builder()
.acceptLanguage("string")
.ignoreErrors(false)
.name("string")
.notificationArns("string")
.pathId("string")
.pathName("string")
.productId("string")
.productName("string")
.provisioningArtifactId("string")
.provisioningArtifactName("string")
.provisioningParameters(ProvisionedProductProvisioningParameterArgs.builder()
.key("string")
.usePreviousValue(false)
.value("string")
.build())
.retainPhysicalResources(false)
.stackSetProvisioningPreferences(ProvisionedProductStackSetProvisioningPreferencesArgs.builder()
.accounts("string")
.failureToleranceCount(0)
.failureTolerancePercentage(0)
.maxConcurrencyCount(0)
.maxConcurrencyPercentage(0)
.regions("string")
.build())
.tags(Map.of("string", "string"))
.build());
provisioned_product_resource = aws.servicecatalog.ProvisionedProduct("provisionedProductResource",
accept_language="string",
ignore_errors=False,
name="string",
notification_arns=["string"],
path_id="string",
path_name="string",
product_id="string",
product_name="string",
provisioning_artifact_id="string",
provisioning_artifact_name="string",
provisioning_parameters=[{
"key": "string",
"usePreviousValue": False,
"value": "string",
}],
retain_physical_resources=False,
stack_set_provisioning_preferences={
"accounts": ["string"],
"failureToleranceCount": 0,
"failureTolerancePercentage": 0,
"maxConcurrencyCount": 0,
"maxConcurrencyPercentage": 0,
"regions": ["string"],
},
tags={
"string": "string",
})
const provisionedProductResource = new aws.servicecatalog.ProvisionedProduct("provisionedProductResource", {
acceptLanguage: "string",
ignoreErrors: false,
name: "string",
notificationArns: ["string"],
pathId: "string",
pathName: "string",
productId: "string",
productName: "string",
provisioningArtifactId: "string",
provisioningArtifactName: "string",
provisioningParameters: [{
key: "string",
usePreviousValue: false,
value: "string",
}],
retainPhysicalResources: false,
stackSetProvisioningPreferences: {
accounts: ["string"],
failureToleranceCount: 0,
failureTolerancePercentage: 0,
maxConcurrencyCount: 0,
maxConcurrencyPercentage: 0,
regions: ["string"],
},
tags: {
string: "string",
},
});
type: aws:servicecatalog:ProvisionedProduct
properties:
acceptLanguage: string
ignoreErrors: false
name: string
notificationArns:
- string
pathId: string
pathName: string
productId: string
productName: string
provisioningArtifactId: string
provisioningArtifactName: string
provisioningParameters:
- key: string
usePreviousValue: false
value: string
retainPhysicalResources: false
stackSetProvisioningPreferences:
accounts:
- string
failureToleranceCount: 0
failureTolerancePercentage: 0
maxConcurrencyCount: 0
maxConcurrencyPercentage: 0
regions:
- string
tags:
string: string
ProvisionedProduct Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ProvisionedProduct resource accepts the following input properties:
- Accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - Ignore
Errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - Name string
User-friendly name of the provisioned product.
The following arguments are optional:
- Notification
Arns List<string> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- Path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - Path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - Product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - Product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - Provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Parameters List<ProvisionedProduct Provisioning Parameter> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - Retain
Physical boolResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - Stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Dictionary<string, string>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - Ignore
Errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - Name string
User-friendly name of the provisioned product.
The following arguments are optional:
- Notification
Arns []string - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- Path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - Path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - Product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - Product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - Provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Parameters []ProvisionedProduct Provisioning Parameter Args - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - Retain
Physical boolResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - Stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences Args - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - map[string]string
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- accept
Language String - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - ignore
Errors Boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - name String
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns List<String> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- path
Id String - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name String - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id String - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name String - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact StringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact StringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters List<ProvisionedProduct Provisioning Parameter> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical BooleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Map<String,String>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - ignore
Errors boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - name string
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns string[] - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters ProvisionedProduct Provisioning Parameter[] - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical booleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - {[key: string]: string}
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- accept_
language str - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - ignore_
errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - name str
User-friendly name of the provisioned product.
The following arguments are optional:
- notification_
arns Sequence[str] - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- path_
id str - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path_
name str - Name of the path. You must provide
path_id
orpath_name
, but not both. - product_
id str - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product_
name str - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning_
artifact_ strid - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning_
artifact_ strname - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning_
parameters Sequence[ProvisionedProduct Provisioning Parameter Args] - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain_
physical_ boolresources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack_
set_ Provisionedprovisioning_ preferences Product Stack Set Provisioning Preferences Args - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Mapping[str, str]
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- accept
Language String - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - ignore
Errors Boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - name String
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns List<String> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- path
Id String - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name String - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id String - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name String - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact StringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact StringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters List<Property Map> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical BooleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set Property MapProvisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Map<String>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProvisionedProduct resource produces the following output properties:
- Arn string
- ARN of the provisioned product.
- Cloudwatch
Dashboard List<string>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- Created
Time string - Time when the provisioned product was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Last
Record stringId - Record identifier of the last request performed on this provisioned product.
- Last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- Outputs
List<Provisioned
Product Output> - The set of outputs for the product created.
- Status string
- Current status of the provisioned product. See meanings below.
- Status
Message string - Current status message of the provisioned product.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- Arn string
- ARN of the provisioned product.
- Cloudwatch
Dashboard []stringNames - Set of CloudWatch dashboards that were created when provisioning the product.
- Created
Time string - Time when the provisioned product was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Last
Record stringId - Record identifier of the last request performed on this provisioned product.
- Last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- Outputs
[]Provisioned
Product Output Type - The set of outputs for the product created.
- Status string
- Current status of the provisioned product. See meanings below.
- Status
Message string - Current status message of the provisioned product.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- arn String
- ARN of the provisioned product.
- cloudwatch
Dashboard List<String>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time String - Time when the provisioned product was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Provisioning StringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record StringId - Record identifier of the last request performed on this provisioned product.
- last
Successful StringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role StringArn - ARN of the launch role associated with the provisioned product.
- outputs
List<Provisioned
Product Output> - The set of outputs for the product created.
- status String
- Current status of the provisioned product. See meanings below.
- status
Message String - Current status message of the provisioned product.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type String
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- arn string
- ARN of the provisioned product.
- cloudwatch
Dashboard string[]Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time string - Time when the provisioned product was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record stringId - Record identifier of the last request performed on this provisioned product.
- last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- outputs
Provisioned
Product Output[] - The set of outputs for the product created.
- status string
- Current status of the provisioned product. See meanings below.
- status
Message string - Current status message of the provisioned product.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- arn str
- ARN of the provisioned product.
- cloudwatch_
dashboard_ Sequence[str]names - Set of CloudWatch dashboards that were created when provisioning the product.
- created_
time str - Time when the provisioned product was created.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
provisioning_ strrecord_ id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last_
record_ strid - Record identifier of the last request performed on this provisioned product.
- last_
successful_ strprovisioning_ record_ id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch_
role_ strarn - ARN of the launch role associated with the provisioned product.
- outputs
Sequence[Provisioned
Product Output] - The set of outputs for the product created.
- status str
- Current status of the provisioned product. See meanings below.
- status_
message str - Current status message of the provisioned product.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type str
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- arn String
- ARN of the provisioned product.
- cloudwatch
Dashboard List<String>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time String - Time when the provisioned product was created.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Provisioning StringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record StringId - Record identifier of the last request performed on this provisioned product.
- last
Successful StringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role StringArn - ARN of the launch role associated with the provisioned product.
- outputs List<Property Map>
- The set of outputs for the product created.
- status String
- Current status of the provisioned product. See meanings below.
- status
Message String - Current status message of the provisioned product.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type String
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
Look up Existing ProvisionedProduct Resource
Get an existing ProvisionedProduct resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ProvisionedProductState, opts?: CustomResourceOptions): ProvisionedProduct
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accept_language: Optional[str] = None,
arn: Optional[str] = None,
cloudwatch_dashboard_names: Optional[Sequence[str]] = None,
created_time: Optional[str] = None,
ignore_errors: Optional[bool] = None,
last_provisioning_record_id: Optional[str] = None,
last_record_id: Optional[str] = None,
last_successful_provisioning_record_id: Optional[str] = None,
launch_role_arn: Optional[str] = None,
name: Optional[str] = None,
notification_arns: Optional[Sequence[str]] = None,
outputs: Optional[Sequence[ProvisionedProductOutputArgs]] = None,
path_id: Optional[str] = None,
path_name: Optional[str] = None,
product_id: Optional[str] = None,
product_name: Optional[str] = None,
provisioning_artifact_id: Optional[str] = None,
provisioning_artifact_name: Optional[str] = None,
provisioning_parameters: Optional[Sequence[ProvisionedProductProvisioningParameterArgs]] = None,
retain_physical_resources: Optional[bool] = None,
stack_set_provisioning_preferences: Optional[ProvisionedProductStackSetProvisioningPreferencesArgs] = None,
status: Optional[str] = None,
status_message: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
type: Optional[str] = None) -> ProvisionedProduct
func GetProvisionedProduct(ctx *Context, name string, id IDInput, state *ProvisionedProductState, opts ...ResourceOption) (*ProvisionedProduct, error)
public static ProvisionedProduct Get(string name, Input<string> id, ProvisionedProductState? state, CustomResourceOptions? opts = null)
public static ProvisionedProduct get(String name, Output<String> id, ProvisionedProductState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - Arn string
- ARN of the provisioned product.
- Cloudwatch
Dashboard List<string>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- Created
Time string - Time when the provisioned product was created.
- Ignore
Errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - Last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Last
Record stringId - Record identifier of the last request performed on this provisioned product.
- Last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- Name string
User-friendly name of the provisioned product.
The following arguments are optional:
- Notification
Arns List<string> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- Outputs
List<Provisioned
Product Output> - The set of outputs for the product created.
- Path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - Path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - Product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - Product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - Provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Parameters List<ProvisionedProduct Provisioning Parameter> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - Retain
Physical boolResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - Stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Status string
- Current status of the provisioned product. See meanings below.
- Status
Message string - Current status message of the provisioned product.
- Dictionary<string, string>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- Accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - Arn string
- ARN of the provisioned product.
- Cloudwatch
Dashboard []stringNames - Set of CloudWatch dashboards that were created when provisioning the product.
- Created
Time string - Time when the provisioned product was created.
- Ignore
Errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - Last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Last
Record stringId - Record identifier of the last request performed on this provisioned product.
- Last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - Launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- Name string
User-friendly name of the provisioned product.
The following arguments are optional:
- Notification
Arns []string - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- Outputs
[]Provisioned
Product Output Type Args - The set of outputs for the product created.
- Path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - Path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - Product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - Product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - Provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - Provisioning
Parameters []ProvisionedProduct Provisioning Parameter Args - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - Retain
Physical boolResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - Stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences Args - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - Status string
- Current status of the provisioned product. See meanings below.
- Status
Message string - Current status message of the provisioned product.
- map[string]string
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- accept
Language String - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - arn String
- ARN of the provisioned product.
- cloudwatch
Dashboard List<String>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time String - Time when the provisioned product was created.
- ignore
Errors Boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - last
Provisioning StringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record StringId - Record identifier of the last request performed on this provisioned product.
- last
Successful StringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role StringArn - ARN of the launch role associated with the provisioned product.
- name String
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns List<String> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- outputs
List<Provisioned
Product Output> - The set of outputs for the product created.
- path
Id String - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name String - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id String - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name String - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact StringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact StringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters List<ProvisionedProduct Provisioning Parameter> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical BooleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - status String
- Current status of the provisioned product. See meanings below.
- status
Message String - Current status message of the provisioned product.
- Map<String,String>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type String
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- accept
Language string - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - arn string
- ARN of the provisioned product.
- cloudwatch
Dashboard string[]Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time string - Time when the provisioned product was created.
- ignore
Errors boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - last
Provisioning stringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record stringId - Record identifier of the last request performed on this provisioned product.
- last
Successful stringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role stringArn - ARN of the launch role associated with the provisioned product.
- name string
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns string[] - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- outputs
Provisioned
Product Output[] - The set of outputs for the product created.
- path
Id string - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name string - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id string - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name string - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact stringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact stringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters ProvisionedProduct Provisioning Parameter[] - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical booleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set ProvisionedProvisioning Preferences Product Stack Set Provisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - status string
- Current status of the provisioned product. See meanings below.
- status
Message string - Current status message of the provisioned product.
- {[key: string]: string}
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type string
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- accept_
language str - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - arn str
- ARN of the provisioned product.
- cloudwatch_
dashboard_ Sequence[str]names - Set of CloudWatch dashboards that were created when provisioning the product.
- created_
time str - Time when the provisioned product was created.
- ignore_
errors bool - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - last_
provisioning_ strrecord_ id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last_
record_ strid - Record identifier of the last request performed on this provisioned product.
- last_
successful_ strprovisioning_ record_ id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch_
role_ strarn - ARN of the launch role associated with the provisioned product.
- name str
User-friendly name of the provisioned product.
The following arguments are optional:
- notification_
arns Sequence[str] - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- outputs
Sequence[Provisioned
Product Output Args] - The set of outputs for the product created.
- path_
id str - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path_
name str - Name of the path. You must provide
path_id
orpath_name
, but not both. - product_
id str - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product_
name str - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning_
artifact_ strid - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning_
artifact_ strname - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning_
parameters Sequence[ProvisionedProduct Provisioning Parameter Args] - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain_
physical_ boolresources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack_
set_ Provisionedprovisioning_ preferences Product Stack Set Provisioning Preferences Args - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - status str
- Current status of the provisioned product. See meanings below.
- status_
message str - Current status message of the provisioned product.
- Mapping[str, str]
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type str
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
- accept
Language String - Language code. Valid values:
en
(English),jp
(Japanese),zh
(Chinese). Default value isen
. - arn String
- ARN of the provisioned product.
- cloudwatch
Dashboard List<String>Names - Set of CloudWatch dashboards that were created when provisioning the product.
- created
Time String - Time when the provisioned product was created.
- ignore
Errors Boolean - Only applies to deleting. If set to
true
, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value isfalse
. - last
Provisioning StringRecord Id - Record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - last
Record StringId - Record identifier of the last request performed on this provisioned product.
- last
Successful StringProvisioning Record Id - Record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
,UpdateProvisionedProduct
,ExecuteProvisionedProductPlan
,TerminateProvisionedProduct
. - launch
Role StringArn - ARN of the launch role associated with the provisioned product.
- name String
User-friendly name of the provisioned product.
The following arguments are optional:
- notification
Arns List<String> - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- outputs List<Property Map>
- The set of outputs for the product created.
- path
Id String - 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
aws.servicecatalog.getLaunchPaths
. When required, you must providepath_id
orpath_name
, but not both. - path
Name String - Name of the path. You must provide
path_id
orpath_name
, but not both. - product
Id String - Product identifier. For example,
prod-abcdzk7xy33qa
. You must provideproduct_id
orproduct_name
, but not both. - product
Name String - Name of the product. You must provide
product_id
orproduct_name
, but not both. - provisioning
Artifact StringId - Identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne
. You must provide theprovisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Artifact StringName - Name of the provisioning artifact. You must provide the
provisioning_artifact_id
orprovisioning_artifact_name
, but not both. - provisioning
Parameters List<Property Map> - Configuration block with parameters specified by the administrator that are required for provisioning the product. See
provisioning_parameters
Block for details. - retain
Physical BooleanResources - Only applies to deleting. Whether to delete the Service Catalog provisioned product but leave the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is
false
. - stack
Set Property MapProvisioning Preferences - Configuration block with information about the provisioning preferences for a stack set. See
stack_set_provisioning_preferences
Block for details. - status String
- Current status of the provisioned product. See meanings below.
- status
Message String - Current status message of the provisioned product.
- Map<String>
- Tags to apply to the provisioned product. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - type String
- Type of provisioned product. Valid values are
CFN_STACK
andCFN_STACKSET
.
Supporting Types
ProvisionedProductOutput, ProvisionedProductOutputArgs
- Description string
- The description of the output.
- Key string
- The output key.
- Value string
- The output value.
- Description string
- The description of the output.
- Key string
- The output key.
- Value string
- The output value.
- description String
- The description of the output.
- key String
- The output key.
- value String
- The output value.
- description string
- The description of the output.
- key string
- The output key.
- value string
- The output value.
- description str
- The description of the output.
- key str
- The output key.
- value str
- The output value.
- description String
- The description of the output.
- key String
- The output key.
- value String
- The output value.
ProvisionedProductProvisioningParameter, ProvisionedProductProvisioningParameterArgs
- Key string
- Parameter key.
- Use
Previous boolValue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - Value string
- Parameter value.
- Key string
- Parameter key.
- Use
Previous boolValue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - Value string
- Parameter value.
- key String
- Parameter key.
- use
Previous BooleanValue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - value String
- Parameter value.
- key string
- Parameter key.
- use
Previous booleanValue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - value string
- Parameter value.
- key str
- Parameter key.
- use_
previous_ boolvalue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - value str
- Parameter value.
- key String
- Parameter key.
- use
Previous BooleanValue - Whether to ignore
value
and keep the previous parameter value. Ignored when initially provisioning a product. - value String
- Parameter value.
ProvisionedProductStackSetProvisioningPreferences, ProvisionedProductStackSetProvisioningPreferencesArgs
- Accounts List<string>
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - Failure
Tolerance intCount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - Failure
Tolerance intPercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - Max
Concurrency intCount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - Max
Concurrency intPercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - Regions List<string>
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
- Accounts []string
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - Failure
Tolerance intCount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - Failure
Tolerance intPercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - Max
Concurrency intCount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - Max
Concurrency intPercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - Regions []string
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
- accounts List<String>
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - failure
Tolerance IntegerCount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - failure
Tolerance IntegerPercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - max
Concurrency IntegerCount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - max
Concurrency IntegerPercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - regions List<String>
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
- accounts string[]
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - failure
Tolerance numberCount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - failure
Tolerance numberPercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - max
Concurrency numberCount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - max
Concurrency numberPercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - regions string[]
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
- accounts Sequence[str]
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - failure_
tolerance_ intcount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - failure_
tolerance_ intpercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - max_
concurrency_ intcount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - max_
concurrency_ intpercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - regions Sequence[str]
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
- accounts List<String>
- One or more AWS accounts that will have access to the provisioned product. The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all accounts from the STACKSET constraint. - failure
Tolerance NumberCount - Number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. The default value is 0 if no value is specified. - failure
Tolerance NumberPercentage - Percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. You must specify either
failure_tolerance_count
orfailure_tolerance_percentage
, but not both. - max
Concurrency NumberCount - Maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
failure_tolerance_count
.max_concurrency_count
is at most one more than thefailure_tolerance_count
. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify eithermax_concurrency_count
ormax_concurrency_percentage
, but not both. - max
Concurrency NumberPercentage - Maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead. Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. You must specify either
max_concurrency_count
ormax_concurrency_percentage
, but not both. - regions List<String>
- One or more AWS Regions where the provisioned product will be available. The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the
aws_servicecatalog_provisioning_parameters
data source. If no values are specified, the default value is all regions from the STACKSET constraint.
Import
Using pulumi import
, import aws_servicecatalog_provisioned_product
using the provisioned product ID. For example:
$ pulumi import aws:servicecatalog/provisionedProduct:ProvisionedProduct example pp-dnigbtea24ste
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.