software.amazon.awscdk.services.s3

Class CfnAccessPoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3.CfnAccessPoint

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.018Z")
 @Stability(value=Stable)
public class CfnAccessPoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3::AccessPoint`.

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.s3.*;
 Object policy;
 Object policyStatus;
 CfnAccessPoint cfnAccessPoint = CfnAccessPoint.Builder.create(this, "MyCfnAccessPoint")
         .bucket("bucket")
         // the properties below are optional
         .name("name")
         .policy(policy)
         .policyStatus(policyStatus)
         .publicAccessBlockConfiguration(PublicAccessBlockConfigurationProperty.builder()
                 .blockPublicAcls(false)
                 .blockPublicPolicy(false)
                 .ignorePublicAcls(false)
                 .restrictPublicBuckets(false)
                 .build())
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .vpcId("vpcId")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAccessPoint.Builder A fluent builder for CfnAccessPoint.
static interface	CfnAccessPoint.PublicAccessBlockConfigurationProperty Example:
static interface	CfnAccessPoint.VpcConfigurationProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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(software.constructs.Construct scope, String id, CfnAccessPointProps props) Create a new `AWS::S3::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	getAttrAlias()
String	getAttrArn()
String	getAttrName()
String	getAttrNetworkOrigin()
String	getBucket() `AWS::S3::AccessPoint.Bucket`.
protected Map<String,Object>	getCfnProperties()
String	getName() `AWS::S3::AccessPoint.Name`.
Object	getPolicy() `AWS::S3::AccessPoint.Policy`.
Object	getPolicyStatus() `AWS::S3::AccessPoint.PolicyStatus`.
Object	getPublicAccessBlockConfiguration() `AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.
Object	getVpcConfiguration() `AWS::S3::AccessPoint.VpcConfiguration`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBucket(String value) `AWS::S3::AccessPoint.Bucket`.
void	setName(String value) `AWS::S3::AccessPoint.Name`.
void	setPolicy(Object value) `AWS::S3::AccessPoint.Policy`.
void	setPolicyStatus(Object value) `AWS::S3::AccessPoint.PolicyStatus`.
void	setPublicAccessBlockConfiguration(CfnAccessPoint.PublicAccessBlockConfigurationProperty value) `AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.
void	setPublicAccessBlockConfiguration(IResolvable value) `AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.
void	setVpcConfiguration(CfnAccessPoint.VpcConfigurationProperty value) `AWS::S3::AccessPoint.VpcConfiguration`.
void	setVpcConfiguration(IResolvable value) `AWS::S3::AccessPoint.VpcConfiguration`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnAccessPointProps props)

Create a new `AWS::S3::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.

getAttrAlias

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

getAttrArn

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

getAttrName

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

getAttrNetworkOrigin

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

getBucket

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

`AWS::S3::AccessPoint.Bucket`.

setBucket

@Stability(value=Stable)
public void setBucket(@NotNull
                                               String value)

`AWS::S3::AccessPoint.Bucket`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getName

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

`AWS::S3::AccessPoint.Name`.

setName

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

`AWS::S3::AccessPoint.Name`.

getPolicy

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

`AWS::S3::AccessPoint.Policy`.

setPolicy

@Stability(value=Stable)
public void setPolicy(@NotNull
                                               Object value)

`AWS::S3::AccessPoint.Policy`.

getPolicyStatus

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

`AWS::S3::AccessPoint.PolicyStatus`.

setPolicyStatus

@Stability(value=Stable)
public void setPolicyStatus(@NotNull
                                                     Object value)

`AWS::S3::AccessPoint.PolicyStatus`.

getPublicAccessBlockConfiguration

@Stability(value=Stable)
 @Nullable
public Object getPublicAccessBlockConfiguration()

`AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.

setPublicAccessBlockConfiguration

@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       CfnAccessPoint.PublicAccessBlockConfigurationProperty value)

`AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.

setPublicAccessBlockConfiguration

@Stability(value=Stable)
public void setPublicAccessBlockConfiguration(@Nullable
                                                                       IResolvable value)

`AWS::S3::AccessPoint.PublicAccessBlockConfiguration`.

getVpcConfiguration

@Stability(value=Stable)
 @Nullable
public Object getVpcConfiguration()

`AWS::S3::AccessPoint.VpcConfiguration`.

setVpcConfiguration

@Stability(value=Stable)
public void setVpcConfiguration(@Nullable
                                                         CfnAccessPoint.VpcConfigurationProperty value)

`AWS::S3::AccessPoint.VpcConfiguration`.

setVpcConfiguration

@Stability(value=Stable)
public void setVpcConfiguration(@Nullable
                                                         IResolvable value)

`AWS::S3::AccessPoint.VpcConfiguration`.