pulumi-aws-kotlin/com.pulumi.aws.ram.kotlin/PrincipalAssociationArgs

PrincipalAssociationArgs

data class PrincipalAssociationArgs(val principal: Output<String>? = null, val resourceShareArn: Output<String>? = null) : ConvertibleToJava<PrincipalAssociationArgs>

Provides a Resource Access Manager (RAM) principal association. Depending if RAM Sharing with AWS Organizations is enabled, the RAM behavior with different principal types changes. When RAM Sharing with AWS Organizations is enabled:

  • For AWS Account ID, Organization, and Organizational Unit principals within the same AWS Organization, no resource share invitation is sent and resources become available automatically after creating the association.

  • For AWS Account ID principals outside the AWS Organization, a resource share invitation is sent and must be accepted before resources become available. See the aws.ram.ResourceShareAccepter resource to accept these invitations. When RAM Sharing with AWS Organizations is not enabled:

  • Organization and Organizational Unit principals cannot be used.

  • For AWS Account ID principals, a resource share invitation is sent and must be accepted before resources become available. See the aws.ram.ResourceShareAccepter resource to accept these invitations.

Example Usage

AWS Account ID

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ram.ResourceShare("example", {allowExternalPrincipals: true});
const examplePrincipalAssociation = new aws.ram.PrincipalAssociation("example", {
    principal: "111111111111",
    resourceShareArn: example.arn,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ram.ResourceShare("example", allow_external_principals=True)
example_principal_association = aws.ram.PrincipalAssociation("example",
    principal="111111111111",
    resource_share_arn=example.arn)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ram.ResourceShare("example", new()
    {
        AllowExternalPrincipals = true,
    });
    var examplePrincipalAssociation = new Aws.Ram.PrincipalAssociation("example", new()
    {
        Principal = "111111111111",
        ResourceShareArn = example.Arn,
    });
});
Content copied to clipboard
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 {
		example, err := ram.NewResourceShare(ctx, "example", &ram.ResourceShareArgs{
			AllowExternalPrincipals: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = ram.NewPrincipalAssociation(ctx, "example", &ram.PrincipalAssociationArgs{
			Principal:        pulumi.String("111111111111"),
			ResourceShareArn: example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ram.ResourceShare;
import com.pulumi.aws.ram.ResourceShareArgs;
import com.pulumi.aws.ram.PrincipalAssociation;
import com.pulumi.aws.ram.PrincipalAssociationArgs;
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 ResourceShare("example", ResourceShareArgs.builder()
            .allowExternalPrincipals(true)
            .build());
        var examplePrincipalAssociation = new PrincipalAssociation("examplePrincipalAssociation", PrincipalAssociationArgs.builder()
            .principal("111111111111")
            .resourceShareArn(example.arn())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:ram:ResourceShare
    properties:
      allowExternalPrincipals: true
  examplePrincipalAssociation:
    type: aws:ram:PrincipalAssociation
    name: example
    properties:
      principal: '111111111111'
      resourceShareArn: ${example.arn}
Content copied to clipboard

AWS Organization

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ram.PrincipalAssociation("example", {
    principal: exampleAwsOrganizationsOrganization.arn,
    resourceShareArn: exampleAwsRamResourceShare.arn,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ram.PrincipalAssociation("example",
    principal=example_aws_organizations_organization["arn"],
    resource_share_arn=example_aws_ram_resource_share["arn"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ram.PrincipalAssociation("example", new()
    {
        Principal = exampleAwsOrganizationsOrganization.Arn,
        ResourceShareArn = exampleAwsRamResourceShare.Arn,
    });
});
Content copied to clipboard
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.NewPrincipalAssociation(ctx, "example", &ram.PrincipalAssociationArgs{
			Principal:        pulumi.Any(exampleAwsOrganizationsOrganization.Arn),
			ResourceShareArn: pulumi.Any(exampleAwsRamResourceShare.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ram.PrincipalAssociation;
import com.pulumi.aws.ram.PrincipalAssociationArgs;
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 PrincipalAssociation("example", PrincipalAssociationArgs.builder()
            .principal(exampleAwsOrganizationsOrganization.arn())
            .resourceShareArn(exampleAwsRamResourceShare.arn())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:ram:PrincipalAssociation
    properties:
      principal: ${exampleAwsOrganizationsOrganization.arn}
      resourceShareArn: ${exampleAwsRamResourceShare.arn}
Content copied to clipboard

Import

Using pulumi import, import RAM Principal Associations using their Resource Share ARN and the principal separated by a comma. For example:

$ pulumi import aws:ram/principalAssociation:PrincipalAssociation example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,123456789012
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(principal: Output<String>? = null, resourceShareArn: Output<String>? = null)

Properties

Link copied to clipboard
val principal: Output<String>? = null

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.

Link copied to clipboard
val resourceShareArn: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): PrincipalAssociationArgs