Product class
Manages a Service Catalog Product.
> NOTE: The user or role that uses this resources must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the templatePhysicalId argument.
> 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.Product("example", {
provisioningArtifactParameters: {
templateUrl: "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json",
},
name: "example",
owner: "example-owner",
type: "CLOUD_FORMATION_TEMPLATE",
tags: {
foo: "bar",
},
});
import pulumi
import pulumi_aws as aws
example = aws.servicecatalog.Product("example",
provisioning_artifact_parameters={
"template_url": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json",
},
name="example",
owner="example-owner",
type="CLOUD_FORMATION_TEMPLATE",
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.Product("example", new()
{
ProvisioningArtifactParameters = new Aws.ServiceCatalog.Inputs.ProductProvisioningArtifactParametersArgs
{
TemplateUrl = "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json",
},
Name = "example",
Owner = "example-owner",
Type = "CLOUD_FORMATION_TEMPLATE",
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.NewProduct(ctx, "example", &servicecatalog.ProductArgs{
ProvisioningArtifactParameters: &servicecatalog.ProductProvisioningArtifactParametersArgs{
TemplateUrl: pulumi.String("https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json"),
},
Name: pulumi.String("example"),
Owner: pulumi.String("example-owner"),
Type: pulumi.String("CLOUD_FORMATION_TEMPLATE"),
Tags: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_servicecatalog_product" "example" {
provisioning_artifact_parameters = {
template_url = "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json"
}
name = "example"
owner = "example-owner"
type = "CLOUD_FORMATION_TEMPLATE"
tags = {
"foo" = "bar"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicecatalog.Product;
import com.pulumi.aws.servicecatalog.ProductArgs;
import com.pulumi.aws.servicecatalog.inputs.ProductProvisioningArtifactParametersArgs;
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 Product("example", ProductArgs.builder()
.provisioningArtifactParameters(ProductProvisioningArtifactParametersArgs.builder()
.templateUrl("https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json")
.build())
.name("example")
.owner("example-owner")
.type("CLOUD_FORMATION_TEMPLATE")
.tags(Map.of("foo", "bar"))
.build());
}
}
resources:
example:
type: aws:servicecatalog:Product
properties:
provisioningArtifactParameters:
templateUrl: https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json
name: example
owner: example-owner
type: CLOUD_FORMATION_TEMPLATE
tags:
foo: bar
Import
Using pulumi import, import aws.servicecatalog.Product using the product ID. For example:
$ pulumi import aws:servicecatalog/product:Product example prod-dnigbtea24ste
Constructors
- Product(String name, {ProductArgs? args, CustomResourceOptions? options})
-
Creates a new Product.
nameThe Pulumi resource name.argsArguments used to configure this Product. The set of arguments for Product.optionsResource options controlling this resource's behavior. - Product.reference(String urn)
- Creates a typed reference to an existing Product resource.
Properties
-
acceptLanguage
↔ Output<
String?> -
Language code. Valid values:
en(English),jp(Japanese),zh(Chinese). Default value isen.latefinal -
arn
↔ Output<
String> -
ARN of the product.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTime
↔ Output<
String> -
Time when the product was created.
latefinal
-
description
↔ Output<
String> -
Description of the product.
latefinal
-
distributor
↔ Output<
String> -
Distributor (i.e., vendor) of the product.
latefinal
-
hasDefaultPath
↔ Output<
bool> -
Whether the product has a default path. If the product does not have a default path, call
ListLaunchPathsto disambiguate between paths. Otherwise,ListLaunchPathsis not required, and the output of ProductViewSummary can be used directly withDescribeProvisioningParameters.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
name
↔ Output<
String> -
Name of the product.
latefinal
-
owner
↔ Output<
String> -
Owner of the product.
latefinal
-
provisioningArtifactParameters
↔ Output<
ProductProvisioningArtifactParameters> -
Configuration block for provisioning artifact (i.e., version) parameters. See
provisioningArtifactParametersBlock 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
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
Status of the product.
latefinal
-
supportDescription
↔ Output<
String> -
Support information about the product.
latefinal
-
supportEmail
↔ Output<
String> -
Contact email for product support.
latefinal
-
supportUrl
↔ Output<
String> -
Contact URL for product support.
latefinal
-
Tags to apply to the product. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of product. See AWS Docs for valid list of values.
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