Class CfnAccessPoint
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
Inherited Members
Namespace: Amazon.CDK.AWS.S3ObjectLambda
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccessPoint : CfnResource, IInspectable, IAccessPointRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnAccessPoint Inherits CfnResource Implements IInspectable, IAccessPointRef, IConstruct, IDependable, IEnvironmentAware
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3ObjectLambda;
var contentTransformation;
var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
ObjectLambdaConfiguration = new ObjectLambdaConfigurationProperty {
SupportingAccessPoint = "supportingAccessPoint",
TransformationConfigurations = new [] { new TransformationConfigurationProperty {
Actions = new [] { "actions" },
ContentTransformation = contentTransformation
} },
// the properties below are optional
AllowedFeatures = new [] { "allowedFeatures" },
CloudWatchMetricsEnabled = false
},
// the properties below are optional
Name = "name"
});
Synopsis
Constructors
| CfnAccessPoint(Construct, string, ICfnAccessPointProps) | Create a new |
Properties
| AccessPointRef | A reference to a AccessPoint resource. |
| AttrAlias | The |
| AttrAliasStatus | The status of the Object Lambda Access Point alias. |
| AttrAliasValue | The alias name value of the Object Lambda Access Point. |
| AttrArn | Specifies the ARN for the Object Lambda Access Point. |
| AttrCreationDate | The date and time when the specified Object Lambda Access Point was created. |
| AttrPolicyStatus | The |
| AttrPolicyStatusIsPublic | Specifies whether the Object lambda Access Point Policy is Public or not. |
| AttrPublicAccessBlockConfiguration | The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point. |
| AttrPublicAccessBlockConfigurationBlockPublicAcls | The |
| AttrPublicAccessBlockConfigurationBlockPublicPolicy | The |
| AttrPublicAccessBlockConfigurationIgnorePublicAcls | The |
| AttrPublicAccessBlockConfigurationRestrictPublicBuckets | The |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | The |
| CfnPropertyNames | The |
| Name | The name of this access point. |
| ObjectLambdaConfiguration | A configuration used when creating an Object Lambda Access Point. |
Methods
| ArnForAccessPoint(IAccessPointRef) | The |
| FromAccessPointArn(Construct, string, string) | Creates a new IAccessPointRef from an ARN. |
| FromAccessPointName(Construct, string, string) | Creates a new IAccessPointRef from a accessPointName. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnAccessPoint(object) | Checks whether the given object is a CfnAccessPoint. |
| RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnAccessPoint(Construct, string, ICfnAccessPointProps)
Create a new AWS::S3ObjectLambda::AccessPoint.
public CfnAccessPoint(Construct scope, string id, ICfnAccessPointProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnAccessPointProps
Resource properties.
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
Properties
AccessPointRef
A reference to a AccessPoint resource.
public virtual IAccessPointReference AccessPointRef { get; }
Property Value
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
AttrAlias
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrAlias { get; }
Property Value
Remarks
CloudformationAttribute: Alias
AttrAliasStatus
The status of the Object Lambda Access Point alias.
public virtual string AttrAliasStatus { get; }
Property Value
Remarks
Valid Values: PROVISIONING | READY .
CloudformationAttribute: Alias.Status
AttrAliasValue
The alias name value of the Object Lambda Access Point.
public virtual string AttrAliasValue { get; }
Property Value
Remarks
For example: myolap-1a4n8yjrb3kda96f67zwrwiiuse1a--ol-s3 .
CloudformationAttribute: Alias.Value
AttrArn
Specifies the ARN for the Object Lambda Access Point.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrCreationDate
The date and time when the specified Object Lambda Access Point was created.
public virtual string AttrCreationDate { get; }
Property Value
Remarks
CloudformationAttribute: CreationDate
AttrPolicyStatus
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrPolicyStatus { get; }
Property Value
Remarks
CloudformationAttribute: PolicyStatus
AttrPolicyStatusIsPublic
Specifies whether the Object lambda Access Point Policy is Public or not.
public virtual IResolvable AttrPolicyStatusIsPublic { get; }
Property Value
Remarks
Object lambda Access Points are private by default.
CloudformationAttribute: PolicyStatus.IsPublic
AttrPublicAccessBlockConfiguration
The Public Access Block Configuration is used to block policies that would allow public access to this Object lambda Access Point.
public virtual IResolvable AttrPublicAccessBlockConfiguration { get; }
Property Value
Remarks
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
AttrPublicAccessBlockConfigurationBlockPublicAcls
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrPublicAccessBlockConfigurationBlockPublicAcls { get; }
Property Value
Remarks
CloudformationAttribute: PublicAccessBlockConfiguration.BlockPublicAcls
AttrPublicAccessBlockConfigurationBlockPublicPolicy
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrPublicAccessBlockConfigurationBlockPublicPolicy { get; }
Property Value
Remarks
CloudformationAttribute: PublicAccessBlockConfiguration.BlockPublicPolicy
AttrPublicAccessBlockConfigurationIgnorePublicAcls
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrPublicAccessBlockConfigurationIgnorePublicAcls { get; }
Property Value
Remarks
CloudformationAttribute: PublicAccessBlockConfiguration.IgnorePublicAcls
AttrPublicAccessBlockConfigurationRestrictPublicBuckets
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public virtual IResolvable AttrPublicAccessBlockConfigurationRestrictPublicBuckets { get; }
Property Value
Remarks
CloudformationAttribute: PublicAccessBlockConfiguration.RestrictPublicBuckets
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
CfnPropertyNames
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
Name
The name of this access point.
public virtual string? Name { get; set; }
Property Value
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
ObjectLambdaConfiguration
A configuration used when creating an Object Lambda Access Point.
public virtual object ObjectLambdaConfiguration { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnAccessPoint.IObjectLambdaConfigurationProperty
Methods
ArnForAccessPoint(IAccessPointRef)
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
public static string ArnForAccessPoint(IAccessPointRef resource)
Parameters
- resource IAccessPointRef
Returns
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3ObjectLambda;
var contentTransformation;
var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
ObjectLambdaConfiguration = new ObjectLambdaConfigurationProperty {
SupportingAccessPoint = "supportingAccessPoint",
TransformationConfigurations = new [] { new TransformationConfigurationProperty {
Actions = new [] { "actions" },
ContentTransformation = contentTransformation
} },
// the properties below are optional
AllowedFeatures = new [] { "allowedFeatures" },
CloudWatchMetricsEnabled = false
},
// the properties below are optional
Name = "name"
});
FromAccessPointArn(Construct, string, string)
Creates a new IAccessPointRef from an ARN.
public static IAccessPointRef FromAccessPointArn(Construct scope, string id, string arn)
Parameters
Returns
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
FromAccessPointName(Construct, string, string)
Creates a new IAccessPointRef from a accessPointName.
public static IAccessPointRef FromAccessPointName(Construct scope, string id, string accessPointName)
Parameters
Returns
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
IsCfnAccessPoint(object)
Checks whether the given object is a CfnAccessPoint.
public static bool IsCfnAccessPoint(object x)
Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::S3ObjectLambda::AccessPoint
ExampleMetadata: fixture=_generated