CfnAccessPointProps

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

Bases: object

Properties for defining a CfnAccessPoint.

Parameters:
  • bucket (str) – The name of the bucket that you want to associate the access point with.

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

  • name (Optional[str]) – An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 . For example, accesspointname–zoneID–xa-s3.

  • policy (Any) – The access point policy associated with the specified access point.

  • public_access_block_configuration (Union[IResolvable, PublicAccessBlockConfigurationProperty, Dict[str, Any], None]) – Public access is blocked by default to access points for directory buckets.

  • scope (Union[IResolvable, ScopeProperty, Dict[str, Any], None]) – You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. For more information, see Manage the scope of your access points for directory buckets.

  • vpc_configuration (Union[IResolvable, VpcConfigurationProperty, Dict[str, Any], None]) – If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-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_s3express as s3express

# policy: Any

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

    # the properties below are optional
    bucket_account_id="bucketAccountId",
    name="name",
    policy=policy,
    public_access_block_configuration=s3express.CfnAccessPoint.PublicAccessBlockConfigurationProperty(
        block_public_acls=False,
        block_public_policy=False,
        ignore_public_acls=False,
        restrict_public_buckets=False
    ),
    scope=s3express.CfnAccessPoint.ScopeProperty(
        permissions=["permissions"],
        prefixes=["prefixes"]
    ),
    vpc_configuration=s3express.CfnAccessPoint.VpcConfigurationProperty(
        vpc_id="vpcId"
    )
)

Attributes

bucket

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

See:

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

bucket_account_id

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

See:

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

name

An access point name consists of a base name you provide, followed by the zoneID ( AWS Local Zone) followed by the prefix --xa-s3 .

For example, accesspointname–zoneID–xa-s3.

See:

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

policy

The access point policy associated with the specified access point.

See:

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

public_access_block_configuration

Public access is blocked by default to access points for directory buckets.

See:

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

scope

You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both.

For more information, see Manage the scope of your access points for directory buckets.

See:

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

vpc_configuration

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

See:

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