Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ram
  5. SharingWithOrganization
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ram.SharingWithOrganization

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Manages Resource Access Manager (RAM) Resource Sharing with AWS Organizations. If you enable sharing with your organization, you can share resources without using invitations. Refer to the AWS RAM user guide for more details.

    NOTE: Use this resource to manage resource sharing within your organization, not the aws.organizations.Organization resource with ram.amazonaws.com configured in aws_service_access_principals.

    Example Usage

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

const example = new aws.ram.SharingWithOrganization("example", {});

    import pulumi
import pulumi_aws as aws

example = aws.ram.SharingWithOrganization("example")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ram.NewSharingWithOrganization(ctx, "example", nil)
		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 example = new Aws.Ram.SharingWithOrganization("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ram.SharingWithOrganization;
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 example = new SharingWithOrganization("example");

    }
}

    resources:
  example:
    type: aws:ram:SharingWithOrganization

    Create SharingWithOrganization Resource

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

    Constructor syntax

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

@overload
def SharingWithOrganization(resource_name: str,
                            opts: Optional[ResourceOptions] = None)
    func NewSharingWithOrganization(ctx *Context, name string, args *SharingWithOrganizationArgs, opts ...ResourceOption) (*SharingWithOrganization, error)
    public SharingWithOrganization(string name, SharingWithOrganizationArgs? args = null, CustomResourceOptions? opts = null)
    public SharingWithOrganization(String name, SharingWithOrganizationArgs args)
public SharingWithOrganization(String name, SharingWithOrganizationArgs args, CustomResourceOptions options)

    type: aws:ram:SharingWithOrganization
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 SharingWithOrganizationArgs
    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 SharingWithOrganizationArgs
    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 SharingWithOrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SharingWithOrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SharingWithOrganizationArgs
    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 sharingWithOrganizationResource = new Aws.Ram.SharingWithOrganization("sharingWithOrganizationResource");

    example, err := ram.NewSharingWithOrganization(ctx, "sharingWithOrganizationResource", nil)

    var sharingWithOrganizationResource = new SharingWithOrganization("sharingWithOrganizationResource");

    sharing_with_organization_resource = aws.ram.SharingWithOrganization("sharingWithOrganizationResource")

    const sharingWithOrganizationResource = new aws.ram.SharingWithOrganization("sharingWithOrganizationResource", {});

    type: aws:ram:SharingWithOrganization
properties: {}

    SharingWithOrganization Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SharingWithOrganization resource accepts the following input properties:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SharingWithOrganization Resource

    Get an existing SharingWithOrganization 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?: SharingWithOrganizationState, opts?: CustomResourceOptions): SharingWithOrganization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ) -> SharingWithOrganization
    func GetSharingWithOrganization(ctx *Context, name string, id IDInput, state *SharingWithOrganizationState, opts ...ResourceOption) (*SharingWithOrganization, error)
    public static SharingWithOrganization Get(string name, Input<string> id, SharingWithOrganizationState? state, CustomResourceOptions? opts = null)
    public static SharingWithOrganization get(String name, Output<String> id, SharingWithOrganizationState 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:

    Import

    Using pulumi import, import the resource using the current AWS account ID. For example:

    $ pulumi import aws:ram/sharingWithOrganization:SharingWithOrganization example 123456789012

    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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws