Package com.pulumi.aws.ram

Class ResourceShare

  • public class ResourceShare
extends com.pulumi.resources.CustomResource
    Manages a Resource Access Manager (RAM) Resource Share. To associate principals with the share, see the `aws.ram.PrincipalAssociation` resource. To associate resources with the share, see the `aws.ram.ResourceAssociation` resource. ## Example Usage 
     
 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 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)
             .tags(Map.of("Environment", "Production"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import resource shares using the `arn` of the resource share. For example: ```sh $ pulumi import aws:ram/resourceShare:ResourceShare example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowExternalPrincipals()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static ResourceShare get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResourceShareState 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.lang.String> name()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> permissionArns()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<ResourceShareResourceShareConfiguration> resourceShareConfiguration()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ResourceShare

        public ResourceShare​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ResourceShare

        public ResourceShare​(java.lang.String name,
                     @Nullable
                     ResourceShareArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ResourceShare

        public ResourceShare​(java.lang.String name,
                     @Nullable
                     ResourceShareArgs 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

      • allowExternalPrincipals

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allowExternalPrincipals()
        Returns:
        Whether principals outside your organization can be associated with a resource share.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the resource share.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the resource share.

      • permissionArns

        public com.pulumi.core.Output<java.util.List<java.lang.String>> permissionArns()
        Returns:
        ARNs of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share.

      • 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.

      • resourceShareConfiguration

        public com.pulumi.core.Output<ResourceShareResourceShareConfiguration> resourceShareConfiguration()
        Returns:
        Configuration block for the resource share. See `resourceShareConfiguration` Block for details.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource share. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static ResourceShare get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                ResourceShareState 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.