Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3
  5. getAccessPoint
AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
pulumi/pulumi-aws

aws.s3.getAccessPoint

Explore with Pulumi AI

aws logo
AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
pulumi/pulumi-aws

    Provides details about a specific S3 access point.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.s3.getAccessPoint({
    name: "example-access-point",
});

    import pulumi
import pulumi_aws as aws

example = aws.s3.get_access_point(name="example-access-point")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3.LookupAccessPoint(ctx, &s3.LookupAccessPointArgs{
			Name: "example-access-point",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.S3.GetAccessPoint.Invoke(new()
    {
        Name = "example-access-point",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.S3Functions;
import com.pulumi.aws.s3.inputs.GetAccessPointArgs;
import java.util.List;
import java.util.ArrayList;
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 example = S3Functions.getAccessPoint(GetAccessPointArgs.builder()
            .name("example-access-point")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:s3:getAccessPoint
      arguments:
        name: example-access-point

    Using getAccessPoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAccessPoint(args: GetAccessPointArgs, opts?: InvokeOptions): Promise<GetAccessPointResult>
function getAccessPointOutput(args: GetAccessPointOutputArgs, opts?: InvokeOptions): Output<GetAccessPointResult>
    def get_access_point(account_id: Optional[str] = None,
                     name: Optional[str] = None,
                     region: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAccessPointResult
def get_access_point_output(account_id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     region: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAccessPointResult]
    func LookupAccessPoint(ctx *Context, args *LookupAccessPointArgs, opts ...InvokeOption) (*LookupAccessPointResult, error)
func LookupAccessPointOutput(ctx *Context, args *LookupAccessPointOutputArgs, opts ...InvokeOption) LookupAccessPointResultOutput

    > Note: This function is named LookupAccessPoint in the Go SDK.

    public static class GetAccessPoint 
{
    public static Task<GetAccessPointResult> InvokeAsync(GetAccessPointArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPointResult> Invoke(GetAccessPointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAccessPointResult> getAccessPoint(GetAccessPointArgs args, InvokeOptions options)
public static Output<GetAccessPointResult> getAccessPoint(GetAccessPointArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:s3/getAccessPoint:getAccessPoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the access point.
    AccountId string
    AWS account ID for the account that owns the specified access point.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Name string
    Name of the access point.
    AccountId string
    AWS account ID for the account that owns the specified access point.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    name String
    Name of the access point.
    accountId String
    AWS account ID for the account that owns the specified access point.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    name string
    Name of the access point.
    accountId string
    AWS account ID for the account that owns the specified access point.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    name str
    Name of the access point.
    account_id str
    AWS account ID for the account that owns the specified access point.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    name String
    Name of the access point.
    accountId String
    AWS account ID for the account that owns the specified access point.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    getAccessPoint Result

    The following output properties are available:

    AccountId string
    Alias string
    Access point alias.
    Arn string
    Access point ARN.
    Bucket string
    Name of the bucket associated with the access point.
    BucketAccountId string
    AWS account ID associated with the S3 bucket associated with the access point.
    DataSourceId string
    Unique identifier for the data source of the access point.
    DataSourceType string
    Type of the data source that the access point is attached to.
    Endpoints Dictionary<string, string>
    VPC endpoint for the access point.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    NetworkOrigin string
    Indicates whether the access point allows access from the public Internet.
    PublicAccessBlockConfigurations List<GetAccessPointPublicAccessBlockConfiguration>
    PublicAccessBlock configuration for the access point.
    Region string
    VpcConfigurations List<GetAccessPointVpcConfiguration>
    VPC configuration for the access point.
    AccountId string
    Alias string
    Access point alias.
    Arn string
    Access point ARN.
    Bucket string
    Name of the bucket associated with the access point.
    BucketAccountId string
    AWS account ID associated with the S3 bucket associated with the access point.
    DataSourceId string
    Unique identifier for the data source of the access point.
    DataSourceType string
    Type of the data source that the access point is attached to.
    Endpoints map[string]string
    VPC endpoint for the access point.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    NetworkOrigin string
    Indicates whether the access point allows access from the public Internet.
    PublicAccessBlockConfigurations []GetAccessPointPublicAccessBlockConfiguration
    PublicAccessBlock configuration for the access point.
    Region string
    VpcConfigurations []GetAccessPointVpcConfiguration
    VPC configuration for the access point.
    accountId String
    alias String
    Access point alias.
    arn String
    Access point ARN.
    bucket String
    Name of the bucket associated with the access point.
    bucketAccountId String
    AWS account ID associated with the S3 bucket associated with the access point.
    dataSourceId String
    Unique identifier for the data source of the access point.
    dataSourceType String
    Type of the data source that the access point is attached to.
    endpoints Map<String,String>
    VPC endpoint for the access point.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    networkOrigin String
    Indicates whether the access point allows access from the public Internet.
    publicAccessBlockConfigurations List<GetAccessPointPublicAccessBlockConfiguration>
    PublicAccessBlock configuration for the access point.
    region String
    vpcConfigurations List<GetAccessPointVpcConfiguration>
    VPC configuration for the access point.
    accountId string
    alias string
    Access point alias.
    arn string
    Access point ARN.
    bucket string
    Name of the bucket associated with the access point.
    bucketAccountId string
    AWS account ID associated with the S3 bucket associated with the access point.
    dataSourceId string
    Unique identifier for the data source of the access point.
    dataSourceType string
    Type of the data source that the access point is attached to.
    endpoints {[key: string]: string}
    VPC endpoint for the access point.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    networkOrigin string
    Indicates whether the access point allows access from the public Internet.
    publicAccessBlockConfigurations GetAccessPointPublicAccessBlockConfiguration[]
    PublicAccessBlock configuration for the access point.
    region string
    vpcConfigurations GetAccessPointVpcConfiguration[]
    VPC configuration for the access point.
    account_id str
    alias str
    Access point alias.
    arn str
    Access point ARN.
    bucket str
    Name of the bucket associated with the access point.
    bucket_account_id str
    AWS account ID associated with the S3 bucket associated with the access point.
    data_source_id str
    Unique identifier for the data source of the access point.
    data_source_type str
    Type of the data source that the access point is attached to.
    endpoints Mapping[str, str]
    VPC endpoint for the access point.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    network_origin str
    Indicates whether the access point allows access from the public Internet.
    public_access_block_configurations Sequence[GetAccessPointPublicAccessBlockConfiguration]
    PublicAccessBlock configuration for the access point.
    region str
    vpc_configurations Sequence[GetAccessPointVpcConfiguration]
    VPC configuration for the access point.
    accountId String
    alias String
    Access point alias.
    arn String
    Access point ARN.
    bucket String
    Name of the bucket associated with the access point.
    bucketAccountId String
    AWS account ID associated with the S3 bucket associated with the access point.
    dataSourceId String
    Unique identifier for the data source of the access point.
    dataSourceType String
    Type of the data source that the access point is attached to.
    endpoints Map<String>
    VPC endpoint for the access point.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    networkOrigin String
    Indicates whether the access point allows access from the public Internet.
    publicAccessBlockConfigurations List<Property Map>
    PublicAccessBlock configuration for the access point.
    region String
    vpcConfigurations List<Property Map>
    VPC configuration for the access point.

    Supporting Types

    GetAccessPointPublicAccessBlockConfiguration

    BlockPublicAcls bool
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    BlockPublicPolicy bool
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    IgnorePublicAcls bool
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    RestrictPublicBuckets bool
    Whether Amazon S3 restricts public bucket policies for buckets in this account.
    BlockPublicAcls bool
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    BlockPublicPolicy bool
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    IgnorePublicAcls bool
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    RestrictPublicBuckets bool
    Whether Amazon S3 restricts public bucket policies for buckets in this account.
    blockPublicAcls Boolean
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    blockPublicPolicy Boolean
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    ignorePublicAcls Boolean
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    restrictPublicBuckets Boolean
    Whether Amazon S3 restricts public bucket policies for buckets in this account.
    blockPublicAcls boolean
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    blockPublicPolicy boolean
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    ignorePublicAcls boolean
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    restrictPublicBuckets boolean
    Whether Amazon S3 restricts public bucket policies for buckets in this account.
    block_public_acls bool
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    block_public_policy bool
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    ignore_public_acls bool
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    restrict_public_buckets bool
    Whether Amazon S3 restricts public bucket policies for buckets in this account.
    blockPublicAcls Boolean
    Whether Amazon S3 blocks public ACLs for buckets in this account.
    blockPublicPolicy Boolean
    Whether Amazon S3 blocks public bucket policies for buckets in this account.
    ignorePublicAcls Boolean
    Whether Amazon S3 ignores public ACLs for buckets in this account.
    restrictPublicBuckets Boolean
    Whether Amazon S3 restricts public bucket policies for buckets in this account.

    GetAccessPointVpcConfiguration

    VpcId string
    Access point will only allow connections from this VPC.
    VpcId string
    Access point will only allow connections from this VPC.
    vpcId String
    Access point will only allow connections from this VPC.
    vpcId string
    Access point will only allow connections from this VPC.
    vpc_id str
    Access point will only allow connections from this VPC.
    vpcId String
    Access point will only allow connections from this VPC.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v7.1.0 published on Monday, Jul 21, 2025 by Pulumi
    pulumi/pulumi-aws