Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. servicecatalog
  5. Portfolio
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.servicecatalog.Portfolio

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a resource to create a Service Catalog Portfolio.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const portfolio = new aws.servicecatalog.Portfolio("portfolio", {
    name: "My App Portfolio",
    description: "List of my organizations apps",
    providerName: "Brett",
});

    import pulumi
import pulumi_aws as aws

portfolio = aws.servicecatalog.Portfolio("portfolio",
    name="My App Portfolio",
    description="List of my organizations apps",
    provider_name="Brett")

    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.NewPortfolio(ctx, "portfolio", &servicecatalog.PortfolioArgs{
			Name:         pulumi.String("My App Portfolio"),
			Description:  pulumi.String("List of my organizations apps"),
			ProviderName: pulumi.String("Brett"),
		})
		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 portfolio = new Aws.ServiceCatalog.Portfolio("portfolio", new()
    {
        Name = "My App Portfolio",
        Description = "List of my organizations apps",
        ProviderName = "Brett",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicecatalog.Portfolio;
import com.pulumi.aws.servicecatalog.PortfolioArgs;
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 portfolio = new Portfolio("portfolio", PortfolioArgs.builder()
            .name("My App Portfolio")
            .description("List of my organizations apps")
            .providerName("Brett")
            .build());

    }
}

    resources:
  portfolio:
    type: aws:servicecatalog:Portfolio
    properties:
      name: My App Portfolio
      description: List of my organizations apps
      providerName: Brett

    Create Portfolio Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Portfolio(name: string, args: PortfolioArgs, opts?: CustomResourceOptions);
    @overload
def Portfolio(resource_name: str,
              args: PortfolioArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Portfolio(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              provider_name: Optional[str] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewPortfolio(ctx *Context, name string, args PortfolioArgs, opts ...ResourceOption) (*Portfolio, error)
    public Portfolio(string name, PortfolioArgs args, CustomResourceOptions? opts = null)
    public Portfolio(String name, PortfolioArgs args)
public Portfolio(String name, PortfolioArgs args, CustomResourceOptions options)

    type: aws:servicecatalog:Portfolio
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 PortfolioArgs
    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 PortfolioArgs
    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 PortfolioArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortfolioArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortfolioArgs
    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 portfolioResource = new Aws.ServiceCatalog.Portfolio("portfolioResource", new()
{
    ProviderName = "string",
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := servicecatalog.NewPortfolio(ctx, "portfolioResource", &servicecatalog.PortfolioArgs{
	ProviderName: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var portfolioResource = new Portfolio("portfolioResource", PortfolioArgs.builder()
    .providerName("string")
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    portfolio_resource = aws.servicecatalog.Portfolio("portfolioResource",
    provider_name="string",
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const portfolioResource = new aws.servicecatalog.Portfolio("portfolioResource", {
    providerName: "string",
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:servicecatalog:Portfolio
properties:
    description: string
    name: string
    providerName: string
    tags:
        string: string

    Portfolio 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 Portfolio resource accepts the following input properties:

    ProviderName string
    Name of the person or organization who owns the portfolio.
    Description string
    Description of the portfolio
    Name string
    The name of the portfolio.
    Tags Dictionary<string, string>
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ProviderName string
    Name of the person or organization who owns the portfolio.
    Description string
    Description of the portfolio
    Name string
    The name of the portfolio.
    Tags map[string]string
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    providerName String
    Name of the person or organization who owns the portfolio.
    description String
    Description of the portfolio
    name String
    The name of the portfolio.
    tags Map<String,String>
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    providerName string
    Name of the person or organization who owns the portfolio.
    description string
    Description of the portfolio
    name string
    The name of the portfolio.
    tags {[key: string]: string}
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    provider_name str
    Name of the person or organization who owns the portfolio.
    description str
    Description of the portfolio
    name str
    The name of the portfolio.
    tags Mapping[str, str]
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    providerName String
    Name of the person or organization who owns the portfolio.
    description String
    Description of the portfolio
    name String
    The name of the portfolio.
    tags Map<String>
    Tags to apply to the connection. 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 Portfolio resource produces the following output properties:

    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    createdTime string
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    created_time str
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Portfolio Resource

    Get an existing Portfolio 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?: PortfolioState, opts?: CustomResourceOptions): Portfolio
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_time: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        provider_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Portfolio
    func GetPortfolio(ctx *Context, name string, id IDInput, state *PortfolioState, opts ...ResourceOption) (*Portfolio, error)
    public static Portfolio Get(string name, Input<string> id, PortfolioState? state, CustomResourceOptions? opts = null)
    public static Portfolio get(String name, Output<String> id, PortfolioState 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.
    The following state arguments are supported:
    Arn string
    CreatedTime string
    Description string
    Description of the portfolio
    Name string
    The name of the portfolio.
    ProviderName string
    Name of the person or organization who owns the portfolio.
    Tags Dictionary<string, string>
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    CreatedTime string
    Description string
    Description of the portfolio
    Name string
    The name of the portfolio.
    ProviderName string
    Name of the person or organization who owns the portfolio.
    Tags map[string]string
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    createdTime String
    description String
    Description of the portfolio
    name String
    The name of the portfolio.
    providerName String
    Name of the person or organization who owns the portfolio.
    tags Map<String,String>
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    createdTime string
    description string
    Description of the portfolio
    name string
    The name of the portfolio.
    providerName string
    Name of the person or organization who owns the portfolio.
    tags {[key: string]: string}
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    created_time str
    description str
    Description of the portfolio
    name str
    The name of the portfolio.
    provider_name str
    Name of the person or organization who owns the portfolio.
    tags Mapping[str, str]
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    createdTime String
    description String
    Description of the portfolio
    name String
    The name of the portfolio.
    providerName String
    Name of the person or organization who owns the portfolio.
    tags Map<String>
    Tags to apply to the connection. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Service Catalog Portfolios using the Service Catalog Portfolio id. For example:

    $ pulumi import aws:servicecatalog/portfolio:Portfolio testfolio port-12344321

    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.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws