Module ram

@pulumi/aws > ram

class PrincipalAssociation

extends CustomResource

Provides a Resource Access Manager (RAM) principal association.

NOTE: For an AWS Account ID principal, the target account must accept the RAM association invitation after resource creation.

Example Usage

AWS Account ID

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

const exampleResourceShare = new aws.ram.ResourceShare("example", {
    // ... other configuration ...
    allowExternalPrincipals: true,
});
const examplePrincipalAssociation = new aws.ram.PrincipalAssociation("example", {
    principal: "111111111111",
    resourceShareArn: exampleResourceShare.arn,
});

AWS Organization

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

const example = new aws.ram.PrincipalAssociation("example", {
    principal: aws_organizations_organization_example.arn,
    resourceShareArn: aws_ram_resource_share_example.arn,
});

constructor

new PrincipalAssociation(name: string, args: PrincipalAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a PrincipalAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PrincipalAssociationState, opts?: pulumi.CustomResourceOptions): PrincipalAssociation

Get an existing PrincipalAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property principal

public principal: pulumi.Output<string>;

The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.

property resourceShareArn

public resourceShareArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the resource share.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ResourceAssociation

extends CustomResource

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 and AWS service specific documentation for additional information.

Example Usage

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

const example = new aws.ram.ResourceAssociation("example", {
    resourceArn: aws_subnet_example.arn,
    resourceShareArn: aws_ram_resource_share_example.arn,
});

constructor

new ResourceAssociation(name: string, args: ResourceAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a ResourceAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ResourceAssociationState, opts?: pulumi.CustomResourceOptions): ResourceAssociation

Get an existing ResourceAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceArn

public resourceArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.

property resourceShareArn

public resourceShareArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the RAM Resource Share.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ResourceShare

extends CustomResource

Manages a Resource Access Manager (RAM) Resource Share. To association principals with the share, see the aws_ram_principal_association resource. To associate resources with the share, see the aws_ram_resource_association resource.

Example Usage

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

const example = new aws.ram.ResourceShare("example", {
    allowExternalPrincipals: true,
    tags: {
        Environment: "Production",
    },
});

constructor

new ResourceShare(name: string, args?: ResourceShareArgs, opts?: pulumi.CustomResourceOptions)

Create a ResourceShare resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ResourceShareState, opts?: pulumi.CustomResourceOptions): ResourceShare

Get an existing ResourceShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowExternalPrincipals

public allowExternalPrincipals: pulumi.Output<boolean | undefined>;

Indicates whether principals outside your organization can be associated with a resource share.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the resource share.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the resource share.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource share.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getResourceShare

getResourceShare(args: GetResourceShareArgs, opts?: pulumi.InvokeOptions): Promise<GetResourceShareResult>

aws_ram_resource_share Retrieve information about a RAM Resource Share.

Example Usage

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

const example = pulumi.output(aws.ram.getResourceShare({
    name: "example",
}));

Search by filters

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

const tagFilter = pulumi.output(aws.ram.getResourceShare({
    filters: [{
        name: "NameOfTag",
        values: ["exampleNameTagValue"],
    }],
    name: "MyResourceName",
    resourceOwner: "SELF",
}));

interface GetResourceShareArgs

A collection of arguments for invoking getResourceShare.

property filters

filters?: {
    name: string;
    values: string[];
}[];

A filter used to scope the list e.g. by tags. See related docs.

property name

name: string;

The name of the tag key to filter on.

property resourceOwner

resourceOwner: string;

The owner of the resource share. Valid values are SELF or OTHER-ACCOUNTS

interface GetResourceShareResult

A collection of values returned by getResourceShare.

property arn

arn: string;

The Amazon Resource Name (ARN) of the resource share.

property filters

filters?: {
    name: string;
    values: string[];
}[];

property id

id: string;

The Amazon Resource Name (ARN) of the resource share.

property name

name: string;

property resourceOwner

resourceOwner: string;

property status

status: string;

The Status of the RAM share.

property tags

tags: {[key: string]: any};

The Tags attached to the RAM share

interface PrincipalAssociationArgs

The set of arguments for constructing a PrincipalAssociation resource.

property principal

principal: pulumi.Input<string>;

The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.

property resourceShareArn

resourceShareArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the resource share.

interface PrincipalAssociationState

Input properties used for looking up and filtering PrincipalAssociation resources.

property principal

principal?: pulumi.Input<string>;

The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.

property resourceShareArn

resourceShareArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the resource share.

interface ResourceAssociationArgs

The set of arguments for constructing a ResourceAssociation resource.

property resourceArn

resourceArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.

property resourceShareArn

resourceShareArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the RAM Resource Share.

interface ResourceAssociationState

Input properties used for looking up and filtering ResourceAssociation resources.

property resourceArn

resourceArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.

property resourceShareArn

resourceShareArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the RAM Resource Share.

interface ResourceShareArgs

The set of arguments for constructing a ResourceShare resource.

property allowExternalPrincipals

allowExternalPrincipals?: pulumi.Input<boolean>;

Indicates whether principals outside your organization can be associated with a resource share.

property name

name?: pulumi.Input<string>;

The name of the resource share.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource share.

interface ResourceShareState

Input properties used for looking up and filtering ResourceShare resources.

property allowExternalPrincipals

allowExternalPrincipals?: pulumi.Input<boolean>;

Indicates whether principals outside your organization can be associated with a resource share.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the resource share.

property name

name?: pulumi.Input<string>;

The name of the resource share.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource share.