Package com.pulumi.aws.s3

Class AccessPoint

  • public class AccessPoint
extends com.pulumi.resources.CustomResource
    Provides a resource to manage an S3 Access Point. > **NOTE on Access Points and Access Point Policies:** This provider provides both a standalone Access Point Policy resource and an Access Point resource with a resource policy defined in-line. You cannot use an Access Point with in-line resource policy in conjunction with an Access Point Policy resource. Doing so will cause a conflict of policies and will overwrite the access point's resource policy. > Advanced usage: To use a custom API endpoint for this resource, use the `s3control` endpoint provider configuration), not the `s3` endpoint provider configuration. > This resource can be used with s3 directory buckets. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-directory-buckets.html) for more information. ## Example Usage ### AWS Partition General Purpose Bucket 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3.Bucket;
 import com.pulumi.aws.s3.BucketArgs;
 import com.pulumi.aws.s3.AccessPoint;
 import com.pulumi.aws.s3.AccessPointArgs;
 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 Bucket("example", BucketArgs.builder()
             .bucket("example")
             .build());
 
         var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
             .bucket(example.id())
             .name("example")
             .build());
 
     }
 }
    ### S3 on Outposts Bucket 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.s3control.Bucket;
 import com.pulumi.aws.s3control.BucketArgs;
 import com.pulumi.aws.ec2.Vpc;
 import com.pulumi.aws.ec2.VpcArgs;
 import com.pulumi.aws.s3.AccessPoint;
 import com.pulumi.aws.s3.AccessPointArgs;
 import com.pulumi.aws.s3.inputs.AccessPointVpcConfigurationArgs;
 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 Bucket("example", BucketArgs.builder()
             .bucket("example")
             .build());
 
         var exampleVpc = new Vpc("exampleVpc", VpcArgs.builder()
             .cidrBlock("10.0.0.0/16")
             .build());
 
         var exampleAccessPoint = new AccessPoint("exampleAccessPoint", AccessPointArgs.builder()
             .vpcConfiguration(AccessPointVpcConfigurationArgs.builder()
                 .vpcId(exampleVpc.id())
                 .build())
             .bucket(example.arn())
             .name("example")
             .build());
 
     }
 }
    ### AWS Partition Directory Bucket 
     
 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 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(test.bucket())
             .name("example--zoneId--xa-s3")
             .build());
 
     }
 }
    ## Import Import using the ARN for Access Points associated with an S3 on Outposts Bucket: **Using `pulumi import` to import.** For example: Import using the `accountId` and `name` separated by a colon (`:`) for Access Points associated with an AWS Partition S3 Bucket: ```sh $ pulumi import aws:s3/accessPoint:AccessPoint example 123456789012:example ``` Import using the ARN for Access Points associated with an S3 on Outposts Bucket: ```sh $ pulumi import aws:s3/accessPoint:AccessPoint example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-1234567890123456/accesspoint/example ```

    • 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()  
      com.pulumi.core.Output<java.lang.String> alias()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> bucket()  
      com.pulumi.core.Output<java.lang.String> bucketAccountId()  
      com.pulumi.core.Output<java.lang.String> domainName()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> endpoints()  
      static AccessPoint get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AccessPointState 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.Boolean> hasPublicAccessPolicy()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> networkOrigin()  
      com.pulumi.core.Output<java.lang.String> policy()  
      com.pulumi.core.Output<java.util.Optional<AccessPointPublicAccessBlockConfiguration>> publicAccessBlockConfiguration()  
      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()  
      com.pulumi.core.Output<java.util.Optional<AccessPointVpcConfiguration>> vpcConfiguration()  

      • 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

      • AccessPoint

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

      • AccessPoint

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

      • AccessPoint

        public AccessPoint​(java.lang.String name,
                   AccessPointArgs 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 for the owner of the bucket for which you want to create an access point. Defaults to automatically determined account ID of the AWS provider.

      • alias

        public com.pulumi.core.Output<java.lang.String> alias()
        Returns:
        Alias of the S3 Access Point.

      • arn

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

      • bucket

        public com.pulumi.core.Output<java.lang.String> bucket()
        Returns:
        Name of an AWS Partition S3 General Purpose Bucket or the ARN of S3 on Outposts Bucket that you want to associate this access point with.

      • bucketAccountId

        public com.pulumi.core.Output<java.lang.String> bucketAccountId()
        Returns:
        AWS account ID associated with the S3 bucket associated with this access point.

      • domainName

        public com.pulumi.core.Output<java.lang.String> domainName()
        Returns:
        DNS domain name of the S3 Access Point in the format _`name`_-_`accountId`_.s3-accesspoint._region_.amazonaws.com. S3 access points only support secure access by HTTPS. HTTP isn't supported.

      • endpoints

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> endpoints()
        Returns:
        VPC endpoints for the S3 Access Point.

      • hasPublicAccessPolicy

        public com.pulumi.core.Output<java.lang.Boolean> hasPublicAccessPolicy()
        Returns:
        Whether this access point currently has a policy that allows public access.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name you want to assign to this access point. See the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-access-points.html?icmpid=docs_amazons3_console#access-points-names) for naming conditions. The following arguments are optional:

      • networkOrigin

        public com.pulumi.core.Output<java.lang.String> networkOrigin()
        Returns:
        Whether this access point allows access from the public Internet. Values are `VPC` (the access point doesn't allow access from the public Internet) and `Internet` (the access point allows access from the public Internet, subject to the access point and bucket access policies).

      • policy

        public com.pulumi.core.Output<java.lang.String> policy()
        Returns:
        Valid JSON document that specifies the policy that you want to apply to this access point. Removing `policy` from your configuration or setting `policy` to null or an empty string (i.e., `policy = ""`) _will not_ delete the policy since it could have been set by `aws.s3control.AccessPointPolicy`. To remove the `policy`, set it to `"{}"` (an empty JSON document).

      • publicAccessBlockConfiguration

        public com.pulumi.core.Output<java.util.Optional<AccessPointPublicAccessBlockConfiguration>> publicAccessBlockConfiguration()
        Returns:
        Configuration block to manage the `PublicAccessBlock` configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Detailed below.

      • 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:
        Map of tags to assign to the bucket. 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.

      • vpcConfiguration

        public com.pulumi.core.Output<java.util.Optional<AccessPointVpcConfiguration>> vpcConfiguration()
        Returns:
        Configuration block to restrict access to this access point to requests from the specified VPC. Required for S3 on Outposts. Detailed below.

      • get

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