Package com.pulumi.aws.s3control

Class AccessGrantsLocation

  • public class AccessGrantsLocation
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an S3 Access Grants location. A location is an S3 resource (bucket or prefix) in a permission grant that the grantee can access. The S3 data must be in the same Region as your S3 Access Grants instance. When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3control.AccessGrantsInstance;
 import com.pulumi.aws.s3control.AccessGrantsLocation;
 import com.pulumi.aws.s3control.AccessGrantsLocationArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 AccessGrantsInstance("example");
 
         var exampleAccessGrantsLocation = new AccessGrantsLocation("exampleAccessGrantsLocation", AccessGrantsLocationArgs.builder()
             .iamRoleArn(exampleAwsIamRole.arn())
             .locationScope("s3://")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example)
                 .build());
 
     }
 }
    ## Import Using `pulumi import`, import S3 Access Grants locations using the `accountId` and `accessGrantsLocationId`, separated by a comma (`,`). For example: ```sh $ pulumi import aws:s3control/accessGrantsLocation:AccessGrantsLocation example 123456789012,default ```

    • 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> accessGrantsLocationArn()  
      com.pulumi.core.Output<java.lang.String> accessGrantsLocationId()  
      com.pulumi.core.Output<java.lang.String> accountId()  
      static AccessGrantsLocation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccessGrantsLocationState 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> iamRoleArn()  
      com.pulumi.core.Output<java.lang.String> locationScope()  
      com.pulumi.core.Output<java.lang.String> region()  
      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

      • AccessGrantsLocation

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

      • AccessGrantsLocation

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

      • AccessGrantsLocation

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

      • accessGrantsLocationArn

        public com.pulumi.core.Output<java.lang.String> accessGrantsLocationArn()
        Returns:
        ARN of the S3 Access Grants location.

      • accessGrantsLocationId

        public com.pulumi.core.Output<java.lang.String> accessGrantsLocationId()
        Returns:
        Unique ID of the S3 Access Grants location.

      • accountId

        public com.pulumi.core.Output<java.lang.String> accountId()
        Returns:
        AWS account ID for the S3 Access Grants location. Defaults to automatically determined account ID of the Terraform AWS provider.

      • iamRoleArn

        public com.pulumi.core.Output<java.lang.String> iamRoleArn()
        Returns:
        ARN of the IAM role that S3 Access Grants should use when fulfilling runtime access requests to the location.

      • locationScope

        public com.pulumi.core.Output<java.lang.String> locationScope()
        Returns:
        Default S3 URI `s3://` or the URI to a custom location, a specific bucket or prefix.

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

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. 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 AccessGrantsLocation get​(java.lang.String name,
                                       com.pulumi.core.Output<java.lang.String> id,
                                       @Nullable
                                       AccessGrantsLocationState 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.