Package com.pulumi.aws.ram
Class ResourceShareAssociationsExclusive
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.ram.ResourceShareAssociationsExclusive
-
public class ResourceShareAssociationsExclusive extends com.pulumi.resources.CustomResourceResource for maintaining exclusive management of principal and resource associations for an AWS RAM (Resource Access Manager) Resource Share. > This resource takes exclusive ownership over principal and resource associations for a resource share. This includes removal of principals and resources which are not explicitly configured. > Destruction of this resource will disassociate all configured principals and resources from the resource share. > **NOTE:** This resource cannot be used in conjunction with `aws.ram.PrincipalAssociation` or `aws.ram.ResourceAssociation` for the same resource share. Using them together will cause persistent drift and conflicts. ## Example Usage ### Basic Usage with Principals
### With Organization Principalpackage 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.ec2.Vpc; import com.pulumi.aws.ec2.VpcArgs; import com.pulumi.aws.ec2.Subnet; import com.pulumi.aws.ec2.SubnetArgs; import com.pulumi.aws.ram.ResourceShareAssociationsExclusive; import com.pulumi.aws.ram.ResourceShareAssociationsExclusiveArgs; 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() .name("example") .allowExternalPrincipals(true) .build()); var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder() .cidrBlock("10.0.0.0/16") .build()); var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder() .vpcId(exampleVpc.id()) .cidrBlock("10.0.1.0/24") .build()); var exampleResourceShareAssociationsExclusive = new ResourceShareAssociationsExclusive("exampleResourceShareAssociationsExclusive", ResourceShareAssociationsExclusiveArgs.builder() .resourceShareArn(example.arn()) .principals( "111111111111", "222222222222") .resourceArns(exampleSubnet.arn()) .build()); } }
### With Service Principals When sharing resources with AWS services, use service principals. Service principals follow the pattern `service-id.amazonaws.com` (e.g., `pca-connector-ad.amazonaws.com`, `elasticmapreduce.amazonaws.com`). The `sources` argument can be used to restrict which AWS accounts the service can access the shared resources from. > **NOTE:** Service principals cannot be mixed with other principal types (AWS account IDs, organization ARNs, OU ARNs, IAM role ARNs, or IAM user ARNs) in the same resource.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.ec2.Vpc; import com.pulumi.aws.ec2.VpcArgs; import com.pulumi.aws.ec2.Subnet; import com.pulumi.aws.ec2.SubnetArgs; import com.pulumi.std.StdFunctions; import com.pulumi.std.inputs.CidrsubnetArgs; import com.pulumi.aws.ram.ResourceShareAssociationsExclusive; import com.pulumi.aws.ram.ResourceShareAssociationsExclusiveArgs; import com.pulumi.codegen.internal.KeyedValue; 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() .name("example") .build()); var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder() .cidrBlock("10.0.0.0/16") .build()); for (var i = 0; i < 2; i++) { new Subnet("exampleSubnet-" + i, SubnetArgs.builder() .vpcId(exampleVpc.id()) .cidrBlock(StdFunctions.cidrsubnet(CidrsubnetArgs.builder() .input(exampleVpc.cidrBlock()) .newbits(8) .netnum(range.value()) .build()).applyValue(_invoke -> _invoke.result())) .build()); } var exampleResourceShareAssociationsExclusive = new ResourceShareAssociationsExclusive("exampleResourceShareAssociationsExclusive", ResourceShareAssociationsExclusiveArgs.builder() .resourceShareArn(example.arn()) .principals(exampleAwsOrganizationsOrganization.arn()) .resourceArns(exampleSubnet.stream().map(element -> element.arn()).collect(toList())) .build()); } }
### Disallow All Associations To automatically remove any configured associations, omit the `principals` and `resourceArns` arguments or set them to empty lists. > This will not **prevent** associations from being created via Terraform (or any other interface). This resource enables bringing associations into a configured state, however, this reconciliation happens only when `apply` is proactively run.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.acmpca.CertificateAuthority; import com.pulumi.aws.acmpca.CertificateAuthorityArgs; import com.pulumi.aws.acmpca.inputs.CertificateAuthorityCertificateAuthorityConfigurationArgs; import com.pulumi.aws.acmpca.inputs.CertificateAuthorityCertificateAuthorityConfigurationSubjectArgs; import com.pulumi.aws.ram.ResourceShareAssociationsExclusive; import com.pulumi.aws.ram.ResourceShareAssociationsExclusiveArgs; 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() .name("example-service-share") .allowExternalPrincipals(true) .build()); var exampleCertificateAuthority = new CertificateAuthority("exampleCertificateAuthority", CertificateAuthorityArgs.builder() .certificateAuthorityConfiguration(CertificateAuthorityCertificateAuthorityConfigurationArgs.builder() .subject(CertificateAuthorityCertificateAuthorityConfigurationSubjectArgs.builder() .commonName("example.com") .build()) .keyAlgorithm("RSA_4096") .signingAlgorithm("SHA512WITHRSA") .build()) .type("ROOT") .build()); var exampleResourceShareAssociationsExclusive = new ResourceShareAssociationsExclusive("exampleResourceShareAssociationsExclusive", ResourceShareAssociationsExclusiveArgs.builder() .resourceShareArn(example.arn()) .principals("pca-connector-ad.amazonaws.com") .resourceArns(exampleCertificateAuthority.arn()) .sources( "111111111111", "222222222222") .build()); } }
## Import ### Identity Schema #### Required - `resourceShareArn` (String) ARN of the RAM resource share. Using `pulumi import`, import RAM Resource Share Association Exclusive using the `resourceShareArn`. For example: ```sh $ pulumi import aws:ram/resourceShareAssociationsExclusive:ResourceShareAssociationsExclusive example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12 ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.ram.ResourceShareAssociationsExclusive; import com.pulumi.aws.ram.ResourceShareAssociationsExclusiveArgs; 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 ResourceShareAssociationsExclusive("example", ResourceShareAssociationsExclusiveArgs.builder() .resourceShareArn(exampleAwsRamResourceShare.arn()) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description ResourceShareAssociationsExclusive(java.lang.String name)ResourceShareAssociationsExclusive(java.lang.String name, ResourceShareAssociationsExclusiveArgs args)ResourceShareAssociationsExclusive(java.lang.String name, ResourceShareAssociationsExclusiveArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceShareAssociationsExclusiveget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResourceShareAssociationsExclusiveState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>principals()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>resourceArns()com.pulumi.core.Output<java.lang.String>resourceShareArn()com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>sources()
-
-
-
Constructor Detail
-
ResourceShareAssociationsExclusive
public ResourceShareAssociationsExclusive(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
ResourceShareAssociationsExclusive
public ResourceShareAssociationsExclusive(java.lang.String name, ResourceShareAssociationsExclusiveArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
ResourceShareAssociationsExclusive
public ResourceShareAssociationsExclusive(java.lang.String name, ResourceShareAssociationsExclusiveArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
principals
public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> principals()
- Returns:
- Set of principals to associate with the resource share. Principals not configured in this argument will be removed. Valid values include: AWS account ID (exactly 12 digits, e.g., `123456789012`), AWS Organizations Organization ARN (e.g., `arn:aws:organizations::123456789012:organization/o-exampleorgid`), AWS Organizations Organizational Unit ARN (e.g., `arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid`), IAM role ARN (e.g., `arn:aws:iam::123456789012:role/example-role`), IAM user ARN (e.g., `arn:aws:iam::123456789012:user/example-user`), or service principal (e.g., `ec2.amazonaws.com`).
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
resourceArns
public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> resourceArns()
- Returns:
- Set of ARNs of resources to associate with the resource share. Resources not configured in this argument will be removed.
-
resourceShareArn
public com.pulumi.core.Output<java.lang.String> resourceShareArn()
- Returns:
- ARN of the resource share. Changing this value forces creation of a new resource.
-
sources
public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> sources()
- Returns:
- Set of AWS account IDs that restrict which accounts a service principal can access resources from. This argument can only be specified when `principals` contains only service principals. When specified, it limits the source accounts from which the service can access the shared resources.
-
get
public static ResourceShareAssociationsExclusive get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable ResourceShareAssociationsExclusiveState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-