CfnAccessPointProps

class aws_cdk.aws_s3.CfnAccessPointProps(*, bucket, bucket_account_id=None, name=None, policy=None, policy_status=None, public_access_block_configuration=None, vpc_configuration=None)

Bases: object

Properties for defining a CfnAccessPoint.

Parameters
  • bucket (str) – The name of the bucket associated with this access point.

  • bucket_account_id (Optional[str]) – The AWS account ID associated with the S3 bucket associated with this access point.

  • name (Optional[str]) – The name of 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.

  • policy (Optional[Any]) – The access point policy associated with this access point.

  • policy_status (Optional[Any]) – The container element for a bucket’s policy status.

  • public_access_block_configuration (Union[PublicAccessBlockConfigurationProperty, Dict[str, Any], IResolvable, None]) – The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. 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 .

  • vpc_configuration (Union[VpcConfigurationProperty, Dict[str, Any], IResolvable, None]) – The Virtual Private Cloud (VPC) configuration for this access point, if one exists.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3

# policy: Any
# policy_status: Any

cfn_access_point_props = s3.CfnAccessPointProps(
    bucket="bucket",

    # the properties below are optional
    bucket_account_id="bucketAccountId",
    name="name",
    policy=policy,
    policy_status=policy_status,
    public_access_block_configuration=s3.CfnAccessPoint.PublicAccessBlockConfigurationProperty(
        block_public_acls=False,
        block_public_policy=False,
        ignore_public_acls=False,
        restrict_public_buckets=False
    ),
    vpc_configuration=s3.CfnAccessPoint.VpcConfigurationProperty(
        vpc_id="vpcId"
    )
)

Attributes

bucket

The name of the bucket associated with this access point.

Link

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

bucket_account_id

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

Link

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

name

The name of 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.

Link

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

policy

The access point policy associated with this access point.

Link

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

policy_status

The container element for a bucket’s policy status.

Link

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

public_access_block_configuration

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

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 .

Link

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

vpc_configuration

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

Link

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