com.pulumi.aws.ram.kotlin.PrincipalAssociation.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.ram.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [PrincipalAssociation].
*/
@PulumiTagMarker
public class PrincipalAssociationResourceBuilder internal constructor() {
public var name: String? = null
public var args: PrincipalAssociationArgs = PrincipalAssociationArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend PrincipalAssociationArgsBuilder.() -> Unit) {
val builder = PrincipalAssociationArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): PrincipalAssociation {
val builtJavaResource = com.pulumi.aws.ram.PrincipalAssociation(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PrincipalAssociation(builtJavaResource)
}
}
/**
* Provides a Resource Access Manager (RAM) principal association. Depending if [RAM Sharing with AWS Organizations is enabled](https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html#getting-started-sharing-orgs), 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
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:ram:ResourceShare
* properties:
* allowExternalPrincipals: true
* examplePrincipalAssociation:
* type: aws:ram:PrincipalAssociation
* name: example
* properties:
* principal: '111111111111'
* resourceShareArn: ${example.arn}
* ```
*
* ### AWS Organization
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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"])
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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:
* ```sh
* $ pulumi import aws:ram/principalAssociation:PrincipalAssociation example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,123456789012
* ```
*/
public class PrincipalAssociation internal constructor(
override val javaResource: com.pulumi.aws.ram.PrincipalAssociation,
) : KotlinCustomResource(javaResource, PrincipalAssociationMapper) {
/**
* 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.
*/
public val principal: Output
get() = javaResource.principal().applyValue({ args0 -> args0 })
/**
* The Amazon Resource Name (ARN) of the resource share.
*/
public val resourceShareArn: Output
get() = javaResource.resourceShareArn().applyValue({ args0 -> args0 })
}
public object PrincipalAssociationMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.ram.PrincipalAssociation::class == javaResource::class
override fun map(javaResource: Resource): PrincipalAssociation = PrincipalAssociation(
javaResource
as com.pulumi.aws.ram.PrincipalAssociation,
)
}
/**
* @see [PrincipalAssociation].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PrincipalAssociation].
*/
public suspend fun principalAssociation(
name: String,
block: suspend PrincipalAssociationResourceBuilder.() -> Unit,
): PrincipalAssociation {
val builder = PrincipalAssociationResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PrincipalAssociation].
* @param name The _unique_ name of the resulting resource.
*/
public fun principalAssociation(name: String): PrincipalAssociation {
val builder = PrincipalAssociationResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy