ProvisionedProduct class

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.

> Tip: If you include conflicted keys as tags, AWS will report an error, "Parameter validation failed: Missing required parameter in TagsN: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", {
    provisioningParameters: [{
        key: "foo",
        value: "bar",
    }],
    name: "example",
    productName: "Example product",
    provisioningArtifactName: "Example version",
    tags: {
        foo: "bar",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.servicecatalog.ProvisionedProduct("example",
    provisioning_parameters=[{
        "key": "foo",
        "value": "bar",
    }],
    name="example",
    product_name="Example product",
    provisioning_artifact_name="Example version",
    tags={
        "foo": "bar",
    })
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()
    {
        ProvisioningParameters = new[]
        {
            new Aws.ServiceCatalog.Inputs.ProvisionedProductProvisioningParameterArgs
            {
                Key = "foo",
                Value = "bar",
            },
        },
        Name = "example",
        ProductName = "Example product",
        ProvisioningArtifactName = "Example version",
        Tags =
        {
            { "foo", "bar" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			ProvisioningParameters: servicecatalog.ProvisionedProductProvisioningParameterArray{
				&servicecatalog.ProvisionedProductProvisioningParameterArgs{
					Key:   pulumi.String("foo"),
					Value: pulumi.String("bar"),
				},
			},
			Name:                     pulumi.String("example"),
			ProductName:              pulumi.String("Example product"),
			ProvisioningArtifactName: pulumi.String("Example version"),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_servicecatalog_provisionedproduct" "example" {
  provisioning_parameters {
    key   = "foo"
    value = "bar"
  }
  name                       = "example"
  product_name               = "Example product"
  provisioning_artifact_name = "Example version"
  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.ArrayList;
import java.util.Arrays;
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()
            .provisioningParameters(ProvisionedProductProvisioningParameterArgs.builder()
                .key("foo")
                .value("bar")
                .build())
            .name("example")
            .productName("Example product")
            .provisioningArtifactName("Example version")
            .tags(Map.of("foo", "bar"))
            .build());

    }
}
resources:
  example:
    type: aws:servicecatalog:ProvisionedProduct
    properties:
      provisioningParameters:
        - key: foo
          value: bar
      name: example
      productName: Example product
      provisioningArtifactName: Example version
      tags:
        foo: bar

Import

Using pulumi import, import aws.servicecatalog.ProvisionedProduct using the provisioned product ID. For example:

$ pulumi import aws:servicecatalog/provisionedProduct:ProvisionedProduct example pp-dnigbtea24ste

Constructors

ProvisionedProduct(String name, {ProvisionedProductArgs? args, CustomResourceOptions? options})
Creates a new ProvisionedProduct. name The Pulumi resource name. args Arguments used to configure this ProvisionedProduct. The set of arguments for ProvisionedProduct. options Resource options controlling this resource's behavior.
ProvisionedProduct.reference(String urn)
Creates a typed reference to an existing ProvisionedProduct resource.

Properties

acceptLanguage ↔ Output<String?>
Language code. Valid values: en (English), jp (Japanese), zh (Chinese). Default value is en.
latefinal
arn ↔ Output<String>
ARN of the provisioned product.
latefinal
childResources → Set<Resource>
finalinherited
cloudwatchDashboardNames ↔ Output<List<String>>
Set of CloudWatch dashboards that were created when provisioning the product.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdTime ↔ Output<String>
Time when the provisioned product was created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ignoreErrors ↔ Output<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 is false.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastProvisioningRecordId ↔ Output<String>
Record identifier of the last request performed on this provisioned product of the following types: ProvisionedProduct, UpdateProvisionedProduct, ExecuteProvisionedProductPlan, TerminateProvisionedProduct.
latefinal
lastRecordId ↔ Output<String>
Record identifier of the last request performed on this provisioned product.
latefinal
lastSuccessfulProvisioningRecordId ↔ Output<String>
Record identifier of the last successful request performed on this provisioned product of the following types: ProvisionedProduct, UpdateProvisionedProduct, ExecuteProvisionedProductPlan, TerminateProvisionedProduct.
latefinal
launchRoleArn ↔ Output<String>
ARN of the launch role associated with the provisioned product.
latefinal
name ↔ Output<String>
User-friendly name of the provisioned product.
latefinal
notificationArns ↔ Output<List<String>?>
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
latefinal
outputs ↔ Output<List<ProvisionedProductOutput>>
The set of outputs for the product created.
latefinal
pathId ↔ Output<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 provide pathId or pathName, but not both.
latefinal
pathName ↔ Output<String?>
Name of the path. You must provide pathId or pathName, but not both.
latefinal
productId ↔ Output<String>
Product identifier. For example, prod-abcdzk7xy33qa. You must provide productId or productName, but not both.
latefinal
productName ↔ Output<String?>
Name of the product. You must provide productId or productName, but not both.
latefinal
provisioningArtifactId ↔ Output<String>
Identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne. You must provide the provisioningArtifactId or provisioningArtifactName, but not both.
latefinal
provisioningArtifactName ↔ Output<String?>
Name of the provisioning artifact. You must provide the provisioningArtifactId or provisioningArtifactName, but not both.
latefinal
provisioningParameters ↔ Output<List<ProvisionedProductProvisioningParameter>?>
Configuration block with parameters specified by the administrator that are required for provisioning the product. See provisioningParameters Block for details.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
retainPhysicalResources ↔ Output<bool?>
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.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stackSetProvisioningPreferences ↔ Output<ProvisionedProductStackSetProvisioningPreferences?>
Configuration block with information about the provisioning preferences for a stack set. See stackSetProvisioningPreferences Block for details.
latefinal
status ↔ Output<String>
Current status of the provisioned product. See meanings below.
latefinal
statusMessage ↔ Output<String>
Current status message of the provisioned product.
latefinal
tags ↔ Output<Map<String, String>?>
Tags to apply to the provisioned product. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
Type of provisioned product. Valid values are CFN_STACK and CFN_STACKSET.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ProvisionedProductState? state, CustomResourceOptions? options}) → ProvisionedProduct
Gets an existing ProvisionedProduct resource's state with the given name and id.