software.amazon.awscdk.services.s3objectlambda

Class CfnAccessPoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.s3objectlambda.CfnAccessPoint

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:21.524Z")
 @Stability(value=Stable)
public class CfnAccessPoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3ObjectLambda::AccessPoint`.

The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3objectlambda.*;
 Object contentTransformation;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .objectLambdaConfiguration(ObjectLambdaConfigurationProperty.builder()
                 .supportingAccessPoint("supportingAccessPoint")
                 .transformationConfigurations(List.of(TransformationConfigurationProperty.builder()
                         .actions(List.of("actions"))
                         .contentTransformation(contentTransformation)
                         .build()))
                 // the properties below are optional
                 .allowedFeatures(List.of("allowedFeatures"))
                 .cloudWatchMetricsEnabled(false)
                 .build())
         // the properties below are optional
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAccessPoint.AwsLambdaProperty Example:
static class	CfnAccessPoint.Builder A fluent builder for CfnAccessPoint.
static interface	CfnAccessPoint.ContentTransformationProperty Example:
static interface	CfnAccessPoint.ObjectLambdaConfigurationProperty A configuration used when creating an Object Lambda Access Point.
static interface	CfnAccessPoint.PolicyStatusProperty Indicates whether this access point policy is public.
static interface	CfnAccessPoint.PublicAccessBlockConfigurationProperty The `PublicAccessBlock` configuration that you want to apply to this Amazon S3 account.
static interface	CfnAccessPoint.TransformationConfigurationProperty A configuration used when creating an Object Lambda Access Point transformation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccessPoint(Construct scope, String id, CfnAccessPointProps props) Create a new `AWS::S3ObjectLambda::AccessPoint`.
protected	CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Specifies the ARN for the Object Lambda Access Point.
String	getAttrCreationDate() The date and time when the specified Object Lambda Access Point was created.
IResolvable	getAttrPolicyStatusIsPublic()
IResolvable	getAttrPublicAccessBlockConfigurationBlockPublicAcls()
IResolvable	getAttrPublicAccessBlockConfigurationBlockPublicPolicy()
IResolvable	getAttrPublicAccessBlockConfigurationIgnorePublicAcls()
IResolvable	getAttrPublicAccessBlockConfigurationRestrictPublicBuckets()
protected Map<String,Object>	getCfnProperties()
String	getName() The name of this access point.
Object	getObjectLambdaConfiguration() A configuration used when creating an Object Lambda Access Point.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) The name of this access point.
void	setObjectLambdaConfiguration(CfnAccessPoint.ObjectLambdaConfigurationProperty value) A configuration used when creating an Object Lambda Access Point.
void	setObjectLambdaConfiguration(IResolvable value) A configuration used when creating an Object Lambda Access Point.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccessPoint

protected CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnAccessPoint

protected CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAccessPoint

@Stability(value=Stable)
public CfnAccessPoint(@NotNull
                                               Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnAccessPointProps props)

Create a new `AWS::S3ObjectLambda::AccessPoint`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

Specifies the ARN for the Object Lambda Access Point.

getAttrCreationDate

@Stability(value=Stable)
 @NotNull
public String getAttrCreationDate()

The date and time when the specified Object Lambda Access Point was created.

getAttrPolicyStatusIsPublic

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrPolicyStatusIsPublic()

getAttrPublicAccessBlockConfigurationBlockPublicAcls

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrPublicAccessBlockConfigurationBlockPublicAcls()

getAttrPublicAccessBlockConfigurationBlockPublicPolicy

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrPublicAccessBlockConfigurationBlockPublicPolicy()

getAttrPublicAccessBlockConfigurationIgnorePublicAcls

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrPublicAccessBlockConfigurationIgnorePublicAcls()

getAttrPublicAccessBlockConfigurationRestrictPublicBuckets

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrPublicAccessBlockConfigurationRestrictPublicBuckets()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getObjectLambdaConfiguration

@Stability(value=Stable)
 @NotNull
public Object getObjectLambdaConfiguration()

A configuration used when creating an Object Lambda Access Point.

setObjectLambdaConfiguration

@Stability(value=Stable)
public void setObjectLambdaConfiguration(@NotNull
                                                                  CfnAccessPoint.ObjectLambdaConfigurationProperty value)

A configuration used when creating an Object Lambda Access Point.

setObjectLambdaConfiguration

@Stability(value=Stable)
public void setObjectLambdaConfiguration(@NotNull
                                                                  IResolvable value)

A configuration used when creating an Object Lambda Access Point.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of this access point.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of this access point.