UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

98 lines (97 loc) 4.41 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages a Resource Access Manager (RAM) Resource Association. * * > *NOTE:* Certain AWS resources (e.g., EC2 Subnets) can only be shared in an AWS account that is a member of an AWS Organizations organization with organization-wide Resource Access Manager functionality enabled. See the [Resource Access Manager User Guide](https://docs.aws.amazon.com/ram/latest/userguide/what-is.html) and AWS service specific documentation for additional information. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.ram.ResourceAssociation("example", { * resourceArn: exampleAwsSubnet.arn, * resourceShareArn: exampleAwsRamResourceShare.arn, * }); * ``` * * ## Import * * Using `pulumi import`, import RAM Resource Associations using their Resource Share ARN and Resource ARN separated by a comma. For example: * * ```sh * $ pulumi import aws:ram/resourceAssociation:ResourceAssociation example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,arn:aws:ec2:eu-west-1:123456789012:subnet/subnet-12345678 * ``` */ export declare class ResourceAssociation extends pulumi.CustomResource { /** * Get an existing ResourceAssociation 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?: ResourceAssociationState, opts?: pulumi.CustomResourceOptions): ResourceAssociation; /** * Returns true if the given object is an instance of ResourceAssociation. 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 ResourceAssociation; /** * 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>; /** * Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share. */ readonly resourceArn: pulumi.Output<string>; /** * Amazon Resource Name (ARN) of the RAM Resource Share. */ readonly resourceShareArn: pulumi.Output<string>; /** * Create a ResourceAssociation 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: ResourceAssociationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ResourceAssociation resources. */ export interface ResourceAssociationState { /** * 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>; /** * Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share. */ resourceArn?: pulumi.Input<string>; /** * Amazon Resource Name (ARN) of the RAM Resource Share. */ resourceShareArn?: pulumi.Input<string>; } /** * The set of arguments for constructing a ResourceAssociation resource. */ export interface ResourceAssociationArgs { /** * 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>; /** * Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share. */ resourceArn: pulumi.Input<string>; /** * Amazon Resource Name (ARN) of the RAM Resource Share. */ resourceShareArn: pulumi.Input<string>; }