PrincipalAssociation class
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.ResourceShareAccepterresource 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.ResourceShareAccepterresource 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,
});
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)
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,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ram_resourceshare" "example" {
allow_external_principals = true
}
resource "aws_ram_principalassociation" "example" {
principal = "111111111111"
resource_share_arn = aws_ram_resourceshare.example.arn
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
resources:
example:
type: aws:ram:ResourceShare
properties:
allowExternalPrincipals: true
examplePrincipalAssociation:
type: aws:ram:PrincipalAssociation
name: example
properties:
principal: '111111111111'
resourceShareArn: ${example.arn}
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,
});
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"])
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,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ram_principalassociation" "example" {
principal = exampleAwsOrganizationsOrganization.arn
resource_share_arn = exampleAwsRamResourceShare.arn
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
resources:
example:
type: aws:ram:PrincipalAssociation
properties:
principal: ${exampleAwsOrganizationsOrganization.arn}
resourceShareArn: ${exampleAwsRamResourceShare.arn}
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
Constructors
- PrincipalAssociation(String name, {PrincipalAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new PrincipalAssociation.
nameThe Pulumi resource name.argsArguments used to configure this PrincipalAssociation. The set of arguments for PrincipalAssociation.optionsResource options controlling this resource's behavior. - PrincipalAssociation.reference(String urn)
- Creates a typed reference to an existing PrincipalAssociation resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
principal
↔ Output<
String> -
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.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
ARN of the resource share.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PrincipalAssociationState? state, CustomResourceOptions? options}) → PrincipalAssociation -
Gets an existing PrincipalAssociation resource's state with the given
nameandid.