Package com.pulumi.aws.ram

Class Permission

  • public class Permission
extends com.pulumi.resources.CustomResource
    Manages an AWS RAM (Resource Access Manager) Permission. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ram.Permission;
 import com.pulumi.aws.ram.PermissionArgs;
 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 Permission("example", PermissionArgs.builder()
             .name("custom-backup")
             .policyTemplate("""
 {
     \"Effect\": \"Allow\",
     \"Action\": [
 \t\"backup:ListProtectedResourcesByBackupVault\",
 \t\"backup:ListRecoveryPointsByBackupVault\",
 \t\"backup:DescribeRecoveryPoint\",
 \t\"backup:DescribeBackupVault\"
     ]
 }
             """)
             .resourceType("backup:BackupVault")
             .tags(Map.of("Name", "custom-backup"))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `arn` (String) Permission ARN. Using `pulumi import`, import RAM (Resource Access Manager) Permission using the `exampleIdArg`. For example: ```sh $ pulumi import aws:ram/permission:Permission example arn:aws:ram:us-west-1:123456789012:permission/test-permission ```

    • 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.lang.String> arn()  
      com.pulumi.core.Output<java.lang.Boolean> defaultVersion()  
      static Permission get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PermissionState 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.lang.String> policyTemplate()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> resourceType()  
      com.pulumi.core.Output<java.lang.String> status()  
      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()  
      com.pulumi.core.Output<java.util.Optional<PermissionTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> version()  

      • 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

      • Permission

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

      • Permission

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

      • Permission

        public Permission​(java.lang.String name,
                  PermissionArgs 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

      • arn

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

      • defaultVersion

        public com.pulumi.core.Output<java.lang.Boolean> defaultVersion()
        Returns:
        Whether this is the default version of the managed permission.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the customer managed permission. The name must be unique within the AWS Region.

      • policyTemplate

        public com.pulumi.core.Output<java.lang.String> policyTemplate()
        Returns:
        String in JSON format string that contains the following elements of a resource-based policy: Effect, Action and Condition.

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

      • resourceType

        public com.pulumi.core.Output<java.lang.String> resourceType()
        Returns:
        Name of the resource type that this customer managed permission applies to. The format is `<service-code>:<resource-type>` and is not case sensitive.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Current status of the permission.

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

      • timeouts

        public com.pulumi.core.Output<java.util.Optional<PermissionTimeouts>> timeouts()

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version of the permission associated with this resource share.

      • get

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