Class AccessPoint

Provides a resource to manage an S3 Access Point.

Example Usage

Basic Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var exampleBucket = new Aws.S3.Bucket("exampleBucket", new Aws.S3.BucketArgs
    {
    });
    var exampleAccessPoint = new Aws.S3.AccessPoint("exampleAccessPoint", new Aws.S3.AccessPointArgs
    {
        Bucket = exampleBucket.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AccessPoint

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.S3

Assembly: Pulumi.Aws.dll

Syntax

public class AccessPoint : CustomResource

Constructors

AccessPoint(String, AccessPointArgs, CustomResourceOptions)

Create a AccessPoint resource with the given unique name, arguments, and options.

Declaration

public AccessPoint(string name, AccessPointArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AccessPointArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccountId

The 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 provider.

Declaration

public Output<string> AccountId { get; }

Property Value

Type	Description
Output<System.String>

Arn

Amazon Resource Name (ARN) of the S3 Access Point.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Bucket

The name of the bucket that you want to associate this access point with.

Declaration

public Output<string> Bucket { get; }

Property Value

Type	Description
Output<System.String>

DomainName

The DNS domain name of the S3 Access Point in the format name-account_id.s3-accesspoint.region.amazonaws.com. Note: S3 access points only support secure access by HTTPS. HTTP isn't supported.

Declaration

public Output<string> DomainName { get; }

Property Value

Type	Description
Output<System.String>

HasPublicAccessPolicy

Indicates whether this access point currently has a policy that allows public access.

Declaration

public Output<bool> HasPublicAccessPolicy { get; }

Property Value

Type	Description
Output<System.Boolean>

Name

The name you want to assign to this access point.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NetworkOrigin

Indicates 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).

Declaration

public Output<string> NetworkOrigin { get; }

Property Value

Type	Description
Output<System.String>

Policy

A valid JSON document that specifies the policy that you want to apply to this access point.

Declaration

public Output<string> Policy { get; }

Property Value

Type	Description
Output<System.String>

PublicAccessBlockConfiguration

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.

Declaration

public Output<AccessPointPublicAccessBlockConfiguration> PublicAccessBlockConfiguration { get; }

Property Value

Type	Description
Output<AccessPointPublicAccessBlockConfiguration>

VpcConfiguration

Configuration block to restrict access to this access point to requests from the specified Virtual Private Cloud (VPC). Detailed below.

Declaration

public Output<AccessPointVpcConfiguration> VpcConfiguration { get; }

Property Value

Type	Description
Output<AccessPointVpcConfiguration>

Methods

Get(String, Input<String>, AccessPointState, CustomResourceOptions)

Get an existing AccessPoint resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AccessPoint Get(string name, Input<string> id, AccessPointState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AccessPointState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AccessPoint