Package com.pulumi.aws.s3control

Class DirectoryBucketAccessPointScope

  • public class DirectoryBucketAccessPointScope
extends com.pulumi.resources.CustomResource
    Provides a resource to manage the access point scope for a directory bucket. With access points for directory buckets, you can use the access point scope to restrict access to specific prefixes, API actions, or a combination of both. You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes. For more information, see [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets-manage-scope.html). > For all the services in AWS Local Zones, including Amazon S3, your accountID must be enabled before you can create or access any resource in the Local Zone. You can use the `DescribeAvailabilityZones` API operation to confirm your accountID access to a Local Zone. For more information, see [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/opt-in-directory-bucket-lz.html) > Terraform manages access point scopes for directory buckets with the standalone `aws.s3control.DirectoryBucketAccessPointScope` resource. The `aws.s3.AccessPoint` resource does not support an in-line scope. ## Example Usage ### S3 Access Point Scope for a directory bucket in an AWS Local Zone 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.AwsFunctions;
 import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
 import com.pulumi.aws.s3.DirectoryBucket;
 import com.pulumi.aws.s3.DirectoryBucketArgs;
 import com.pulumi.aws.s3.inputs.DirectoryBucketLocationArgs;
 import com.pulumi.aws.s3.AccessPoint;
 import com.pulumi.aws.s3.AccessPointArgs;
 import com.pulumi.aws.s3control.DirectoryBucketAccessPointScope;
 import com.pulumi.aws.s3control.DirectoryBucketAccessPointScopeArgs;
 import com.pulumi.aws.s3control.inputs.DirectoryBucketAccessPointScopeScopeArgs;
 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) {
         final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
             .state("available")
             .build());
 
         var example = new DirectoryBucket("example", DirectoryBucketArgs.builder()
             .location(DirectoryBucketLocationArgs.builder()
                 .name(available.zoneIds()[0])
                 .build())
             .bucket("example--zoneId--x-s3")
             .build());
 
         var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
             .bucket(example.id())
             .name("example--zoneId--xa-s3")
             .build());
 
         var exampleDirectoryBucketAccessPointScope = new DirectoryBucketAccessPointScope("exampleDirectoryBucketAccessPointScope", DirectoryBucketAccessPointScopeArgs.builder()
             .scope(DirectoryBucketAccessPointScopeScopeArgs.builder()
                 .permissions(                
                     "GetObject",
                     "ListBucket")
                 .prefixes(                
                     "myobject1.csv",
                     "myobject2*")
                 .build())
             .name("example--zoneId--xa-s3")
             .accountId("123456789012")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Access Point Scope using access point name and AWS account ID separated by a colon (`,`). For example: ```sh $ pulumi import aws:s3control/directoryBucketAccessPointScope:DirectoryBucketAccessPointScope example example--zoneid--xa-s3,123456789012 ```

    • 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> accountId()  
      static DirectoryBucketAccessPointScope get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DirectoryBucketAccessPointScopeState 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> region()  
      com.pulumi.core.Output<DirectoryBucketAccessPointScopeScope> scope()  

      • 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

      • DirectoryBucketAccessPointScope

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

      • DirectoryBucketAccessPointScope

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

      • DirectoryBucketAccessPointScope

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

      • accountId

        public com.pulumi.core.Output<java.lang.String> accountId()
        Returns:
        AWS account ID that owns the specified access point.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the access point that you want to apply the scope to.

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

      • scope

        public com.pulumi.core.Output<DirectoryBucketAccessPointScopeScope> scope()
        Returns:
        . Scope is used to restrict access to specific prefixes, API operations, or a combination of both. To remove the `scope`, set it to `{permissions=[] prefixes=[]}`. The default scope is `{permissions=[] prefixes=[]}`.

      • get

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