Class CfnAccessPoint

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAccessPoint

Implements

IInspectable

IAccessPointRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccessPoint : CfnResource, IInspectable, IAccessPointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnAccessPoint Inherits CfnResource Implements IInspectable, IAccessPointRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var policy;

             var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
                 Bucket = "bucket",

                 // the properties below are optional
                 BucketAccountId = "bucketAccountId",
                 Name = "name",
                 Policy = policy,
                 PublicAccessBlockConfiguration = new PublicAccessBlockConfigurationProperty {
                     BlockPublicAcls = false,
                     BlockPublicPolicy = false,
                     IgnorePublicAcls = false,
                     RestrictPublicBuckets = false
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfiguration = new VpcConfigurationProperty {
                     VpcId = "vpcId"
                 }
             });

Synopsis

Constructors

CfnAccessPoint(Construct, string, ICfnAccessPointProps)

Create a new AWS::S3::AccessPoint.

Properties

AccessPointRef	A reference to a AccessPoint resource.
AttrAlias	The alias for this access point.
AttrArn	This property contains the details of the ARN for the access point.
AttrName	The name of this access point.
AttrNetworkOrigin	Indicates whether this access point allows access from the internet.
Bucket	The name of the bucket associated with this access point.
BucketAccountId	The AWS account ID associated with the S3 bucket associated with this access point.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
CfnPropertyNames	The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
Name	The name of this access point.
Policy	The access point policy associated with this access point.
PublicAccessBlockConfiguration	The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
Tags	An array of tags that you can apply to access points.
VpcConfiguration	The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

Methods

ArnForAccessPoint(IAccessPointRef)	The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
FromAccessPointArn(Construct, string, string)	Creates a new IAccessPointRef from an ARN.
FromAccessPointName(Construct, string, string)	Creates a new IAccessPointRef from a accessPointName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnAccessPoint(object)	Checks whether the given object is a CfnAccessPoint.
RenderProperties(IDictionary<string, object>)	The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

Constructors

CfnAccessPoint(Construct, string, ICfnAccessPointProps)

Create a new AWS::S3::AccessPoint.

public CfnAccessPoint(Construct scope, string id, ICfnAccessPointProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAccessPointProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Properties

AccessPointRef

A reference to a AccessPoint resource.

public virtual IAccessPointReference AccessPointRef { get; }

Property Value

IAccessPointReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

AttrAlias

The alias for this access point.

public virtual string AttrAlias { get; }

Property Value

string

Remarks

CloudformationAttribute: Alias

AttrArn

This property contains the details of the ARN for the access point.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrName

The name of this access point.

public virtual string AttrName { get; }

Property Value

string

Remarks

CloudformationAttribute: Name

AttrNetworkOrigin

Indicates whether this access point allows access from the internet.

public virtual string AttrNetworkOrigin { get; }

Property Value

string

Remarks

If VpcConfiguration is specified for this access point, then NetworkOrigin is VPC , and the access point doesn't allow access from the internet. Otherwise, NetworkOrigin is Internet , and the access point allows access from the internet, subject to the access point and bucket access policies.

Allowed values : VPC | Internet

CloudformationAttribute: NetworkOrigin

Bucket

The name of the bucket associated with this access point.

public virtual string Bucket { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

BucketAccountId

The AWS account ID associated with the S3 bucket associated with this access point.

public virtual string? BucketAccountId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

CfnPropertyNames

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Name

The name of this access point.

public virtual string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Policy

The access point policy associated with this access point.

public virtual object Policy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

PublicAccessBlockConfiguration

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.

public virtual object? PublicAccessBlockConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAccessPoint.IPublicAccessBlockConfigurationProperty

Tags

An array of tags that you can apply to access points.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

VpcConfiguration

The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

public virtual object? VpcConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAccessPoint.IVpcConfigurationProperty

Methods

ArnForAccessPoint(IAccessPointRef)

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

public static string ArnForAccessPoint(IAccessPointRef resource)

Parameters

resource IAccessPointRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var policy;

             var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
                 Bucket = "bucket",

                 // the properties below are optional
                 BucketAccountId = "bucketAccountId",
                 Name = "name",
                 Policy = policy,
                 PublicAccessBlockConfiguration = new PublicAccessBlockConfigurationProperty {
                     BlockPublicAcls = false,
                     BlockPublicPolicy = false,
                     IgnorePublicAcls = false,
                     RestrictPublicBuckets = false
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfiguration = new VpcConfigurationProperty {
                     VpcId = "vpcId"
                 }
             });

FromAccessPointArn(Construct, string, string)

Creates a new IAccessPointRef from an ARN.

public static IAccessPointRef FromAccessPointArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IAccessPointRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

FromAccessPointName(Construct, string, string)

Creates a new IAccessPointRef from a accessPointName.

public static IAccessPointRef FromAccessPointName(Construct scope, string id, string accessPointName)

Parameters

scope Construct

id string

accessPointName string

Returns

IAccessPointRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

IsCfnAccessPoint(object)

Checks whether the given object is a CfnAccessPoint.

public static bool IsCfnAccessPoint(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html

CloudformationResource: AWS::S3::AccessPoint

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAccessPointRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2