CfnAccessPoint
- class aws_cdk.aws_s3objectlambda.CfnAccessPoint(scope, id, *, object_lambda_configuration, name=None)
Bases:
CfnResource
The
AWS::S3ObjectLambda::AccessPoint
resource specifies an Object Lambda Access Point used to access a bucket.- See:
- CloudformationResource:
AWS::S3ObjectLambda::AccessPoint
- 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_s3objectlambda as s3objectlambda # content_transformation: Any cfn_access_point = s3objectlambda.CfnAccessPoint(self, "MyCfnAccessPoint", object_lambda_configuration=s3objectlambda.CfnAccessPoint.ObjectLambdaConfigurationProperty( supporting_access_point="supportingAccessPoint", transformation_configurations=[s3objectlambda.CfnAccessPoint.TransformationConfigurationProperty( actions=["actions"], content_transformation=content_transformation )], # the properties below are optional allowed_features=["allowedFeatures"], cloud_watch_metrics_enabled=False ), # the properties below are optional name="name" )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).object_lambda_configuration (
Union
[IResolvable
,ObjectLambdaConfigurationProperty
,Dict
[str
,Any
]]) – A configuration used when creating an Object Lambda Access Point.name (
Optional
[str
]) – The name of this access point.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::S3ObjectLambda::AccessPoint'
- attr_alias
Alias
- Type:
cloudformationAttribute
- attr_alias_status
The status of the Object Lambda Access Point alias.
Valid Values:
PROVISIONING
|READY
.- CloudformationAttribute:
Alias.Status
- attr_alias_value
The alias name value of the Object Lambda Access Point.
For example:
myolap-1a4n8yjrb3kda96f67zwrwiiuse1a--ol-s3
.- CloudformationAttribute:
Alias.Value
- attr_arn
Specifies the ARN for the Object Lambda Access Point.
- CloudformationAttribute:
Arn
- attr_creation_date
The date and time when the specified Object Lambda Access Point was created.
- CloudformationAttribute:
CreationDate
- attr_policy_status
PolicyStatus
- Type:
cloudformationAttribute
- attr_policy_status_is_public
Specifies whether the Object lambda Access Point Policy is Public or not.
Object lambda Access Points are private by default.
- CloudformationAttribute:
PolicyStatus.IsPublic
- attr_public_access_block_configuration
The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point.
All public access to Object lambda Access Points are blocked by default, and any policy that would give public access to them will be also blocked. This behavior cannot be changed for Object lambda Access Points.
- CloudformationAttribute:
PublicAccessBlockConfiguration
- attr_public_access_block_configuration_block_public_acls
PublicAccessBlockConfiguration.BlockPublicAcls
- Type:
cloudformationAttribute
- attr_public_access_block_configuration_block_public_policy
PublicAccessBlockConfiguration.BlockPublicPolicy
- Type:
cloudformationAttribute
- attr_public_access_block_configuration_ignore_public_acls
PublicAccessBlockConfiguration.IgnorePublicAcls
- Type:
cloudformationAttribute
- attr_public_access_block_configuration_restrict_public_buckets
PublicAccessBlockConfiguration.RestrictPublicBuckets
- Type:
cloudformationAttribute
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of this access point.
- node
The tree node.
- object_lambda_configuration
A configuration used when creating an Object Lambda Access Point.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
AliasProperty
- class CfnAccessPoint.AliasProperty(*, value, status=None)
Bases:
object
The 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:
value (
str
) – The alias value of the Object Lambda Access Point.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.
- 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 import aws_s3objectlambda as s3objectlambda alias_property = s3objectlambda.CfnAccessPoint.AliasProperty( value="value", # the properties below are optional status="status" )
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.
AwsLambdaProperty
- class CfnAccessPoint.AwsLambdaProperty(*, function_arn, function_payload=None)
Bases:
object
- Parameters:
function_arn (
str
) –function_payload (
Optional
[str
]) –
- 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 import aws_s3objectlambda as s3objectlambda aws_lambda_property = s3objectlambda.CfnAccessPoint.AwsLambdaProperty( function_arn="functionArn", # the properties below are optional function_payload="functionPayload" )
Attributes
- function_arn
-
- Type:
see
ContentTransformationProperty
- class CfnAccessPoint.ContentTransformationProperty(*, aws_lambda)
Bases:
object
- Parameters:
aws_lambda (
Union
[IResolvable
,AwsLambdaProperty
,Dict
[str
,Any
]]) –- 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 import aws_s3objectlambda as s3objectlambda content_transformation_property = s3objectlambda.CfnAccessPoint.ContentTransformationProperty( aws_lambda=s3objectlambda.CfnAccessPoint.AwsLambdaProperty( function_arn="functionArn", # the properties below are optional function_payload="functionPayload" ) )
Attributes
ObjectLambdaConfigurationProperty
- class CfnAccessPoint.ObjectLambdaConfigurationProperty(*, supporting_access_point, transformation_configurations, allowed_features=None, cloud_watch_metrics_enabled=None)
Bases:
object
A configuration used when creating an Object Lambda Access Point.
- Parameters:
supporting_access_point (
str
) – Standard access point associated with the Object Lambda Access Point.transformation_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,TransformationConfigurationProperty
,Dict
[str
,Any
]]]]) – A container for transformation configurations for an Object Lambda Access Point.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.
- 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 import aws_s3objectlambda as s3objectlambda # content_transformation: Any object_lambda_configuration_property = s3objectlambda.CfnAccessPoint.ObjectLambdaConfigurationProperty( supporting_access_point="supportingAccessPoint", transformation_configurations=[s3objectlambda.CfnAccessPoint.TransformationConfigurationProperty( actions=["actions"], content_transformation=content_transformation )], # the properties below are optional allowed_features=["allowedFeatures"], cloud_watch_metrics_enabled=False )
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 CfnAccessPoint.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 import aws_s3objectlambda as s3objectlambda policy_status_property = s3objectlambda.CfnAccessPoint.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 CfnAccessPoint.PublicAccessBlockConfigurationProperty(*, block_public_acls=None, block_public_policy=None, ignore_public_acls=None, restrict_public_buckets=None)
Bases:
object
The
PublicAccessBlock
configuration 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 toTRUE
causes the following behavior: -PutBucketAcl
andPutObjectAcl
calls 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 toTRUE
causes 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 toTRUE
causes 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 toTRUE
restricts 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 import aws_s3objectlambda as s3objectlambda public_access_block_configuration_property = s3objectlambda.CfnAccessPoint.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
TRUE
causes the following behavior:PutBucketAcl
andPutObjectAcl
calls 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
TRUE
causes 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
TRUE
causes 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
TRUE
restricts 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 CfnAccessPoint.TransformationConfigurationProperty(*, actions, content_transformation)
Bases:
object
A configuration used when creating an Object Lambda Access Point transformation.
- Parameters:
actions (
Sequence
[str
]) – A container for the action of an Object Lambda Access Point configuration. Valid inputs areGetObject
,HeadObject
,ListObjects
, andListObjectsV2
.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 import aws_s3objectlambda as s3objectlambda # content_transformation: Any transformation_configuration_property = s3objectlambda.CfnAccessPoint.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
,ListObjects
, andListObjectsV2
.
- 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 .