Package com.pulumi.aws.servicecatalog

Class ProvisionedProduct

  • public class ProvisionedProduct
extends com.pulumi.resources.CustomResource
    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 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 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.servicecatalog.ProvisionedProduct` using the provisioned product ID. For example: ```sh $ pulumi import aws:servicecatalog/provisionedProduct:ProvisionedProduct example pp-dnigbtea24ste ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Detail

      • ProvisionedProduct

        public ProvisionedProduct​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ProvisionedProduct

        public ProvisionedProduct​(java.lang.String name,
                          @Nullable
                          ProvisionedProductArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ProvisionedProduct

        public ProvisionedProduct​(java.lang.String name,
                          @Nullable
                          ProvisionedProductArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • acceptLanguage

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> acceptLanguage()
        Returns:
        Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the provisioned product.

      • cloudwatchDashboardNames

        public com.pulumi.core.Output<java.util.List<java.lang.String>> cloudwatchDashboardNames()
        Returns:
        Set of CloudWatch dashboards that were created when provisioning the product.

      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        Time when the provisioned product was created.

      • ignoreErrors

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> ignoreErrors()
        Returns:
        _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`.

      • lastProvisioningRecordId

        public com.pulumi.core.Output<java.lang.String> lastProvisioningRecordId()
        Returns:
        Record identifier of the last request performed on this provisioned product of the following types: `ProvisionedProduct`, `UpdateProvisionedProduct`, `ExecuteProvisionedProductPlan`, `TerminateProvisionedProduct`.

      • lastRecordId

        public com.pulumi.core.Output<java.lang.String> lastRecordId()
        Returns:
        Record identifier of the last request performed on this provisioned product.

      • lastSuccessfulProvisioningRecordId

        public com.pulumi.core.Output<java.lang.String> lastSuccessfulProvisioningRecordId()
        Returns:
        Record identifier of the last successful request performed on this provisioned product of the following types: `ProvisionedProduct`, `UpdateProvisionedProduct`, `ExecuteProvisionedProductPlan`, `TerminateProvisionedProduct`.

      • launchRoleArn

        public com.pulumi.core.Output<java.lang.String> launchRoleArn()
        Returns:
        ARN of the launch role associated with the provisioned product.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        User-friendly name of the provisioned product. The following arguments are optional:

      • notificationArns

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> notificationArns()
        Returns:
        Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

      • outputs

        public com.pulumi.core.Output<java.util.List<ProvisionedProductOutput>> outputs()
        Returns:
        The set of outputs for the product created.

      • pathId

        public com.pulumi.core.Output<java.lang.String> pathId()
        Returns:
        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.

      • pathName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> pathName()
        Returns:
        Name of the path. You must provide `pathId` or `pathName`, but not both.

      • productId

        public com.pulumi.core.Output<java.lang.String> productId()
        Returns:
        Product identifier. For example, `prod-abcdzk7xy33qa`. You must provide `productId` or `productName`, but not both.

      • productName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> productName()
        Returns:
        Name of the product. You must provide `productId` or `productName`, but not both.

      • provisioningArtifactId

        public com.pulumi.core.Output<java.lang.String> provisioningArtifactId()
        Returns:
        Identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`. You must provide the `provisioningArtifactId` or `provisioningArtifactName`, but not both.

      • provisioningArtifactName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> provisioningArtifactName()
        Returns:
        Name of the provisioning artifact. You must provide the `provisioningArtifactId` or `provisioningArtifactName`, but not both.

      • provisioningParameters

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ProvisionedProductProvisioningParameter>>> provisioningParameters()
        Returns:
        Configuration block with parameters specified by the administrator that are required for provisioning the product. See `provisioningParameters` Block for details.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • retainPhysicalResources

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> retainPhysicalResources()
        Returns:
        _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`.

      • stackSetProvisioningPreferences

        public com.pulumi.core.Output<java.util.Optional<ProvisionedProductStackSetProvisioningPreferences>> stackSetProvisioningPreferences()
        Returns:
        Configuration block with information about the provisioning preferences for a stack set. See `stackSetProvisioningPreferences` Block for details.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current status of the provisioned product. See meanings below.

      • statusMessage

        public com.pulumi.core.Output<java.lang.String> statusMessage()
        Returns:
        Current status message of the provisioned product.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of provisioned product. Valid values are `CFN_STACK` and `CFN_STACKSET`.

      • get

        public static ProvisionedProduct get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     ProvisionedProductState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.