CfnAccessPointPropsMixin
- class aws_cdk.mixins_preview.aws_s3objectlambda.mixins.CfnAccessPointPropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::S3ObjectLambda::AccessPointresource specifies an Object Lambda Access Point used to access a bucket.- See:
- CloudformationResource:
AWS::S3ObjectLambda::AccessPoint
- Mixin:
true
- 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.mixins_preview import mixins from aws_cdk.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins # content_transformation: Any cfn_access_point_props_mixin = s3objectlambda_mixins.CfnAccessPointPropsMixin(s3objectlambda_mixins.CfnAccessPointMixinProps( name="name", object_lambda_configuration=s3objectlambda_mixins.CfnAccessPointPropsMixin.ObjectLambdaConfigurationProperty( allowed_features=["allowedFeatures"], cloud_watch_metrics_enabled=False, supporting_access_point="supportingAccessPoint", transformation_configurations=[s3objectlambda_mixins.CfnAccessPointPropsMixin.TransformationConfigurationProperty( actions=["actions"], content_transformation=content_transformation )] ) ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::S3ObjectLambda::AccessPoint.- Parameters:
props (
Union[CfnAccessPointMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['name', 'objectLambdaConfiguration']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AliasProperty
- class CfnAccessPointPropsMixin.AliasProperty(*, status=None, value=None)
Bases:
objectThe alias of an Object Lambda Access Point.
For more information, see How to use a bucket-style alias for your S3 bucket Object Lambda Access Point .
- Parameters:
status (
Optional[str]) – The status of the Object Lambda Access Point alias. If the status isPROVISIONING, the Object Lambda Access Point is provisioning the alias and the alias is not ready for use yet. If the status isREADY, the Object Lambda Access Point alias is successfully provisioned and ready for use.value (
Optional[str]) – The alias value of the Object Lambda Access Point.
- See:
- 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.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins alias_property = s3objectlambda_mixins.CfnAccessPointPropsMixin.AliasProperty( status="status", value="value" )
Attributes
- status
The status of the Object Lambda Access Point alias.
If the status is
PROVISIONING, the Object Lambda Access Point is provisioning the alias and the alias is not ready for use yet. If the status isREADY, the Object Lambda Access Point alias is successfully provisioned and ready for use.
- value
The alias value of the Object Lambda Access Point.
ObjectLambdaConfigurationProperty
- class CfnAccessPointPropsMixin.ObjectLambdaConfigurationProperty(*, allowed_features=None, cloud_watch_metrics_enabled=None, supporting_access_point=None, transformation_configurations=None)
Bases:
objectA configuration used when creating an Object Lambda Access Point.
- Parameters:
allowed_features (
Optional[Sequence[str]]) – A container for allowed features. Valid inputs areGetObject-Range,GetObject-PartNumber,HeadObject-Range, andHeadObject-PartNumber.cloud_watch_metrics_enabled (
Union[bool,IResolvable,None]) – A container for whether the CloudWatch metrics configuration is enabled.supporting_access_point (
Optional[str]) – Standard access point associated with the Object Lambda Access Point.transformation_configurations (
Union[IResolvable,Sequence[Union[IResolvable,TransformationConfigurationProperty,Dict[str,Any]]],None]) – A container for transformation configurations for an Object Lambda Access Point.
- See:
- 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.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins # content_transformation: Any object_lambda_configuration_property = s3objectlambda_mixins.CfnAccessPointPropsMixin.ObjectLambdaConfigurationProperty( allowed_features=["allowedFeatures"], cloud_watch_metrics_enabled=False, supporting_access_point="supportingAccessPoint", transformation_configurations=[s3objectlambda_mixins.CfnAccessPointPropsMixin.TransformationConfigurationProperty( actions=["actions"], content_transformation=content_transformation )] )
Attributes
- allowed_features
A container for allowed features.
Valid inputs are
GetObject-Range,GetObject-PartNumber,HeadObject-Range, andHeadObject-PartNumber.
- cloud_watch_metrics_enabled
A container for whether the CloudWatch metrics configuration is enabled.
- supporting_access_point
Standard access point associated with the Object Lambda Access Point.
- transformation_configurations
A container for transformation configurations for an Object Lambda Access Point.
PolicyStatusProperty
- class CfnAccessPointPropsMixin.PolicyStatusProperty(*, is_public=None)
Bases:
object- Parameters:
is_public (
Union[bool,IResolvable,None]) – Specifies whether the Object lambda Access Point Policy is Public or not. Object lambda Access Points are private by default.- See:
- 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.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins policy_status_property = s3objectlambda_mixins.CfnAccessPointPropsMixin.PolicyStatusProperty( is_public=False )
Attributes
- is_public
Specifies whether the Object lambda Access Point Policy is Public or not.
Object lambda Access Points are private by default.
PublicAccessBlockConfigurationProperty
- class CfnAccessPointPropsMixin.PublicAccessBlockConfigurationProperty(*, block_public_acls=None, block_public_policy=None, ignore_public_acls=None, restrict_public_buckets=None)
Bases:
objectThe
PublicAccessBlockconfiguration that you want to apply to this Amazon S3 account.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 .
This data type is not supported for Amazon S3 on Outposts.
- Parameters:
block_public_acls (
Union[bool,IResolvable,None]) – Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element toTRUEcauses the following behavior: -PutBucketAclandPutObjectAclcalls fail if the specified ACL is public. - PUT Object calls fail if the request includes a public ACL. - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn’t affect existing policies or ACLs. This property is not supported for Amazon S3 on Outposts.block_public_policy (
Union[bool,IResolvable,None]) – Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element toTRUEcauses Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn’t affect existing bucket policies. This property is not supported for Amazon S3 on Outposts.ignore_public_acls (
Union[bool,IResolvable,None]) – Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element toTRUEcauses Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn’t affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set. This property is not supported for Amazon S3 on Outposts.restrict_public_buckets (
Union[bool,IResolvable,None]) – Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element toTRUErestricts access to buckets with public policies to only AWS service principals and authorized users within this account. Enabling this setting doesn’t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. This property is not supported for Amazon S3 on Outposts.
- See:
- 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.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins public_access_block_configuration_property = s3objectlambda_mixins.CfnAccessPointPropsMixin.PublicAccessBlockConfigurationProperty( block_public_acls=False, block_public_policy=False, ignore_public_acls=False, restrict_public_buckets=False )
Attributes
- block_public_acls
Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account.
Setting this element to
TRUEcauses the following behavior:PutBucketAclandPutObjectAclcalls fail if the specified ACL is public.PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn’t affect existing policies or ACLs.
This property is not supported for Amazon S3 on Outposts.
- block_public_policy
Specifies whether Amazon S3 should block public bucket policies for buckets in this account.
Setting this element to
TRUEcauses Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.Enabling this setting doesn’t affect existing bucket policies.
This property is not supported for Amazon S3 on Outposts.
- ignore_public_acls
Specifies whether Amazon S3 should ignore public ACLs for buckets in this account.
Setting this element to
TRUEcauses Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.Enabling this setting doesn’t affect the persistence of any existing ACLs and doesn’t prevent new public ACLs from being set.
This property is not supported for Amazon S3 on Outposts.
- restrict_public_buckets
Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account.
Setting this element to
TRUErestricts access to buckets with public policies to only AWS service principals and authorized users within this account.Enabling this setting doesn’t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
This property is not supported for Amazon S3 on Outposts.
TransformationConfigurationProperty
- class CfnAccessPointPropsMixin.TransformationConfigurationProperty(*, actions=None, content_transformation=None)
Bases:
objectA configuration used when creating an Object Lambda Access Point transformation.
- Parameters:
actions (
Optional[Sequence[str]]) – A container for the action of an Object Lambda Access Point configuration. Valid inputs areGetObject,HeadObject,ListObject, andListObjectV2.content_transformation (
Any) – A container for the content transformation of an Object Lambda Access Point configuration. Can include the FunctionArn and FunctionPayload. For more information, see AwsLambdaTransformation in the Amazon S3 API Reference .
- See:
- 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.mixins_preview.aws_s3objectlambda import mixins as s3objectlambda_mixins # content_transformation: Any transformation_configuration_property = s3objectlambda_mixins.CfnAccessPointPropsMixin.TransformationConfigurationProperty( actions=["actions"], content_transformation=content_transformation )
Attributes
- actions
A container for the action of an Object Lambda Access Point configuration.
Valid inputs are
GetObject,HeadObject,ListObject, andListObjectV2.
- content_transformation
A container for the content transformation of an Object Lambda Access Point configuration.
Can include the FunctionArn and FunctionPayload. For more information, see AwsLambdaTransformation in the Amazon S3 API Reference .