@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines (142 loc) • 5.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to create a Service Catalog Portfolio.
*
* ## Example Usage
*
* ```typescript
* 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
*
* Using `pulumi import`, import Service Catalog Portfolios using the Service Catalog Portfolio `id`. For example:
*
* ```sh
* $ pulumi import aws:servicecatalog/portfolio:Portfolio testfolio port-12344321
* ```
*/
export declare class Portfolio extends pulumi.CustomResource {
/**
* Get an existing Portfolio resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PortfolioState, opts?: pulumi.CustomResourceOptions): Portfolio;
/**
* Returns true if the given object is an instance of Portfolio. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Portfolio;
readonly arn: pulumi.Output<string>;
readonly createdTime: pulumi.Output<string>;
/**
* Description of the portfolio
*/
readonly description: pulumi.Output<string>;
/**
* The name of the portfolio.
*/
readonly name: pulumi.Output<string>;
/**
* Name of the person or organization who owns the portfolio.
*/
readonly providerName: pulumi.Output<string>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Tags to apply to the connection. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Portfolio resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: PortfolioArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Portfolio resources.
*/
export interface PortfolioState {
arn?: pulumi.Input<string>;
createdTime?: pulumi.Input<string>;
/**
* Description of the portfolio
*/
description?: pulumi.Input<string>;
/**
* The name of the portfolio.
*/
name?: pulumi.Input<string>;
/**
* Name of the person or organization who owns the portfolio.
*/
providerName?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Tags to apply to the connection. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Portfolio resource.
*/
export interface PortfolioArgs {
/**
* Description of the portfolio
*/
description?: pulumi.Input<string>;
/**
* The name of the portfolio.
*/
name?: pulumi.Input<string>;
/**
* Name of the person or organization who owns the portfolio.
*/
providerName: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Tags to apply to the connection. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}