Class CfnAccessPoint
A CloudFormation AWS::S3::AccessPoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.AWS.S3.dll
Syntax (csharp)
public class CfnAccessPoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAccessPoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
CloudformationResource: AWS::S3::AccessPoint
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accesspoint.html
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
},
VpcConfiguration = new VpcConfigurationProperty {
VpcId = "vpcId"
}
});
Synopsis
Constructors
CfnAccessPoint(Construct, String, ICfnAccessPointProps) | Create a new |
CfnAccessPoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAccessPoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
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. |
CfnProperties | |
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. |
VpcConfiguration | The Virtual Private Cloud (VPC) configuration for this access point, if one exists. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnAccessPointProps
- resource properties.
CfnAccessPoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAccessPoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAccessPoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAccessPoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrAlias
The alias for this access point.
public virtual string AttrAlias { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Alias
AttrArn
This property contains the details of the ARN for the access point.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
The name of this access point.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
AttrNetworkOrigin
Indicates whether this access point allows access from the internet.
public virtual string AttrNetworkOrigin { get; }
Property Value
System.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
System.String
Remarks
BucketAccountId
The AWS account ID associated with the S3 bucket associated with this access point.
public virtual string BucketAccountId { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
The name of this access point.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
Policy
The access point policy associated with this access point.
public virtual object Policy { get; set; }
Property Value
System.Object
Remarks
PublicAccessBlockConfiguration
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
public virtual object PublicAccessBlockConfiguration { get; set; }
Property Value
System.Object
Remarks
You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide .
VpcConfiguration
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
public virtual object VpcConfiguration { get; set; }
Property Value
System.Object
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>