CfnAccessPointProps
- class aws_cdk.aws_s3.CfnAccessPointProps(*, bucket, bucket_account_id=None, name=None, policy=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 (
Any
) – The access point policy associated with this access point.public_access_block_configuration (
Union
[IResolvable
,PublicAccessBlockConfigurationProperty
,Dict
[str
,Any
],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
[IResolvable
,VpcConfigurationProperty
,Dict
[str
,Any
],None
]) – The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
- See:
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 cfn_access_point_props = s3.CfnAccessPointProps( bucket="bucket", # the properties below are optional bucket_account_id="bucketAccountId", name="name", policy=policy, 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.
- bucket_account_id
The AWS account ID associated with the S3 bucket associated with this access point.
- 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.
- policy
The access point policy associated with this access point.
- 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 .
- vpc_configuration
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.