ResourceShare

Manages a Resource Access Manager (RAM) Resource Share. To associate principals with the share, see the aws.ram.PrincipalAssociation resource. To associate resources with the share, see the aws.ram.ResourceAssociation resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Ram.ResourceShare("example", new Aws.Ram.ResourceShareArgs
        {
            AllowExternalPrincipals = true,
            Tags = 
            {
                { "Environment", "Production" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ram"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := ram.NewResourceShare(ctx, "example", &ram.ResourceShareArgs{
            AllowExternalPrincipals: pulumi.Bool(true),
            Tags: pulumi.StringMap{
                "Environment": pulumi.String("Production"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.ram.ResourceShare("example",
    allow_external_principals=True,
    tags={
        "Environment": "Production",
    })

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

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

Create a ResourceShare Resource

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

def ResourceShare(resource_name, opts=None, allow_external_principals=None, name=None, tags=None, __props__=None);

func NewResourceShare(ctx *Context, name string, args *ResourceShareArgs, opts ...ResourceOption) (*ResourceShare, error)

public ResourceShare(string name, ResourceShareArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ResourceShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ResourceShareArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ResourceShareArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ResourceShare Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ResourceShare resource accepts the following input properties:

AllowExternalPrincipals bool: Indicates whether principals outside your organization can be associated with a resource share.
Name string: The name of the resource share.
Tags Dictionary<string, string>: A map of tags to assign to the resource share.

AllowExternalPrincipals bool: Indicates whether principals outside your organization can be associated with a resource share.
Name string: The name of the resource share.
Tags map[string]string: A map of tags to assign to the resource share.

allowExternalPrincipals boolean: Indicates whether principals outside your organization can be associated with a resource share.
name string: The name of the resource share.
tags {[key: string]: string}: A map of tags to assign to the resource share.

allow_external_principals bool: Indicates whether principals outside your organization can be associated with a resource share.
name str: The name of the resource share.
tags Dict[str, str]: A map of tags to assign to the resource share.

Outputs

All input properties are implicitly available as output properties. Additionally, the ResourceShare resource produces the following output properties:

Arn string: The Amazon Resource Name (ARN) of the resource share.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The Amazon Resource Name (ARN) of the resource share.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The Amazon Resource Name (ARN) of the resource share.
id string: The provider-assigned unique ID for this managed resource.

arn str: The Amazon Resource Name (ARN) of the resource share.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ResourceShare Resource

Get an existing ResourceShare 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?: ResourceShareState, opts?: CustomResourceOptions): ResourceShare

static get(resource_name, id, opts=None, allow_external_principals=None, arn=None, name=None, tags=None, __props__=None);

func GetResourceShare(ctx *Context, name string, id IDInput, state *ResourceShareState, opts ...ResourceOption) (*ResourceShare, error)

public static ResourceShare Get(string name, Input<string> id, ResourceShareState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AllowExternalPrincipals bool: Indicates whether principals outside your organization can be associated with a resource share.
Arn string: The Amazon Resource Name (ARN) of the resource share.
Name string: The name of the resource share.
Tags Dictionary<string, string>: A map of tags to assign to the resource share.

AllowExternalPrincipals bool: Indicates whether principals outside your organization can be associated with a resource share.
Arn string: The Amazon Resource Name (ARN) of the resource share.
Name string: The name of the resource share.
Tags map[string]string: A map of tags to assign to the resource share.

allowExternalPrincipals boolean: Indicates whether principals outside your organization can be associated with a resource share.
arn string: The Amazon Resource Name (ARN) of the resource share.
name string: The name of the resource share.
tags {[key: string]: string}: A map of tags to assign to the resource share.

allow_external_principals bool: Indicates whether principals outside your organization can be associated with a resource share.
arn str: The Amazon Resource Name (ARN) of the resource share.
name str: The name of the resource share.
tags Dict[str, str]: A map of tags to assign to the resource share.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud