AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.s3.getAccessPoint

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

function getAccessPoint(args: GetAccessPointArgs, opts?: InvokeOptions): Promise<GetAccessPointResult>
function getAccessPointOutput(args: GetAccessPointOutputArgs, opts?: InvokeOptions): Output<GetAccessPointResult>

def get_access_point(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAccessPointResult
def get_access_point_output(name: 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-native:s3:getAccessPoint
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

Name string: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

name String: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

name string: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

name str: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

name String: The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.

getAccessPoint Result

The following output properties are available:

Alias string

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

Arn string

The Amazon Resource Name (ARN) of the specified accesspoint.

NetworkOrigin Pulumi.AwsNative.S3.AccessPointNetworkOrigin

Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.

Policy object

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

PublicAccessBlockConfiguration Pulumi.AwsNative.S3.Outputs.AccessPointPublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.

Alias string

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

Arn string

The Amazon Resource Name (ARN) of the specified accesspoint.

NetworkOrigin AccessPointNetworkOrigin

Policy interface{}

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

PublicAccessBlockConfiguration AccessPointPublicAccessBlockConfiguration

alias String

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

arn String

The Amazon Resource Name (ARN) of the specified accesspoint.

networkOrigin AccessPointNetworkOrigin

policy Object

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

publicAccessBlockConfiguration AccessPointPublicAccessBlockConfiguration

alias string

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

arn string

The Amazon Resource Name (ARN) of the specified accesspoint.

networkOrigin AccessPointNetworkOrigin

policy any

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

publicAccessBlockConfiguration AccessPointPublicAccessBlockConfiguration

alias str

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

arn str

The Amazon Resource Name (ARN) of the specified accesspoint.

network_origin AccessPointNetworkOrigin

policy Any

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

public_access_block_configuration AccessPointPublicAccessBlockConfiguration

alias String

The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.

arn String

The Amazon Resource Name (ARN) of the specified accesspoint.

networkOrigin "Internet" | "VPC"

policy Any

The Access Point Policy you want to apply to this access point.

Search the CloudFormation User Guide for AWS::S3::AccessPoint for more information about the expected schema for this property.

publicAccessBlockConfiguration Property Map

Supporting Types

AccessPointNetworkOrigin

AccessPointPublicAccessBlockConfiguration

BlockPublicAcls bool

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

BlockPublicPolicy bool

Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.

IgnorePublicAcls bool

Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

RestrictPublicBuckets bool

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

BlockPublicAcls bool

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

BlockPublicPolicy bool

IgnorePublicAcls bool

RestrictPublicBuckets bool

blockPublicAcls Boolean

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

blockPublicPolicy Boolean

ignorePublicAcls Boolean

restrictPublicBuckets Boolean

blockPublicAcls boolean

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

blockPublicPolicy boolean

ignorePublicAcls boolean

restrictPublicBuckets boolean

block_public_acls bool

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

block_public_policy bool

ignore_public_acls bool

restrict_public_buckets bool

blockPublicAcls Boolean

Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:

PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.

blockPublicPolicy Boolean

ignorePublicAcls Boolean

restrictPublicBuckets Boolean