@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:31.499Z") public class CfnAccessPoint extends CfnResource implements IInspectable
The AWS::S3::AccessPoint resource is an Amazon S3 resource type that you can use to access buckets.
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnAccessPoint.Builder
A fluent builder for
CfnAccessPoint . |
static interface |
CfnAccessPoint.PublicAccessBlockConfigurationProperty
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
static interface |
CfnAccessPoint.VpcConfigurationProperty
The Virtual Private Cloud (VPC) configuration for this access point.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAccessPoint(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrAlias()
The alias for this access point.
|
java.lang.String |
getAttrArn()
This property contains the details of the ARN for the access point.
|
java.lang.String |
getAttrName()
The name of this access point.
|
java.lang.String |
getAttrNetworkOrigin()
Indicates whether this access point allows access from the internet.
|
java.lang.String |
getBucket()
The name of the bucket associated with this access point.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getName()
The name of this access point.
|
java.lang.Object |
getPolicy()
The access point policy associated with this access point.
|
java.lang.Object |
getPolicyStatus()
The container element for a bucket's policy status.
|
java.lang.Object |
getPublicAccessBlockConfiguration()
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
java.lang.Object |
getVpcConfiguration()
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBucket(java.lang.String value)
The name of the bucket associated with this access point.
|
void |
setName(java.lang.String value)
The name of this access point.
|
void |
setPolicy(java.lang.Object value)
The access point policy associated with this access point.
|
void |
setPolicyStatus(java.lang.Object value)
The container element for a bucket's policy status.
|
void |
setPublicAccessBlockConfiguration(CfnAccessPoint.PublicAccessBlockConfigurationProperty value)
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
void |
setPublicAccessBlockConfiguration(IResolvable value)
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket.
|
void |
setVpcConfiguration(CfnAccessPoint.VpcConfigurationProperty value)
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
|
void |
setVpcConfiguration(IResolvable value)
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAccessPoint(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAccessPoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAccessPoint(Construct scope, java.lang.String id, CfnAccessPointProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAlias()
public java.lang.String getAttrArn()
public java.lang.String getAttrName()
public java.lang.String getAttrNetworkOrigin()
If VpcConfiguration
is specified for this access point, then NetworkOrigin
is VPC
, and the access point doesn't allow access from the internet. Otherwise, NetworkOrigin
is Internet
, and the access point allows access from the internet, subject to the access point and bucket access policies.
Allowed values : VPC
| Internet
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getBucket()
public void setBucket(java.lang.String value)
public java.lang.Object getPolicy()
public void setPolicy(java.lang.Object value)
public java.lang.Object getPolicyStatus()
public void setPolicyStatus(java.lang.Object value)
public java.lang.String getName()
If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
public void setName(java.lang.String value)
If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
public java.lang.Object getPublicAccessBlockConfiguration()
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 .
public void setPublicAccessBlockConfiguration(IResolvable value)
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 .
public void setPublicAccessBlockConfiguration(CfnAccessPoint.PublicAccessBlockConfigurationProperty value)
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 .
public java.lang.Object getVpcConfiguration()
public void setVpcConfiguration(IResolvable value)
public void setVpcConfiguration(CfnAccessPoint.VpcConfigurationProperty value)