Show / Hide Table of Contents

Class CfnAccessPoint

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAccessPoint
Implements
IInspectable
IAccessPointRef
IConstruct
IDependable
IEnvironmentAware
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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 AWS::S3ObjectLambda::AccessPoint.

Properties

AccessPointRef

A reference to a AccessPoint resource.

AttrAlias

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

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 AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

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 AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

AttrPublicAccessBlockConfigurationBlockPublicPolicy

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

AttrPublicAccessBlockConfigurationIgnorePublicAcls

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

AttrPublicAccessBlockConfigurationRestrictPublicBuckets

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

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

CfnPropertyNames

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

Name

The name of this access point.

ObjectLambdaConfiguration

A configuration used when creating an Object Lambda Access Point.

Methods

ArnForAccessPoint(IAccessPointRef)

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

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 AWS::S3ObjectLambda::AccessPoint resource specifies an Object Lambda Access Point used to access a bucket.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

CloudformationResource: AWS::S3ObjectLambda::AccessPoint

ExampleMetadata: fixture=_generated

Properties

AccessPointRef

A reference to a AccessPoint resource.

public virtual IAccessPointReference AccessPointRef { get; }
Property Value

IAccessPointReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

IResolvable

Remarks

CloudformationAttribute: Alias

AttrAliasStatus

The status of the Object Lambda Access Point alias.

public virtual string AttrAliasStatus { get; }
Property Value

string

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

string

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

string

Remarks

CloudformationAttribute: Arn

AttrCreationDate

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

public virtual string AttrCreationDate { get; }
Property Value

string

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

IResolvable

Remarks

CloudformationAttribute: PolicyStatus

AttrPolicyStatusIsPublic

Specifies whether the Object lambda Access Point Policy is Public or not.

public virtual IResolvable AttrPolicyStatusIsPublic { get; }
Property Value

IResolvable

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

IResolvable

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

IResolvable

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

IResolvable

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

IResolvable

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

IResolvable

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

CloudformationResource: AWS::S3ObjectLambda::AccessPoint

ExampleMetadata: fixture=_generated

Name

The name of this access point.

public virtual string? Name { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

object

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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
scope Construct
id string
arn string
Returns

IAccessPointRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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
scope Construct
id string
accessPointName string
Returns

IAccessPointRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

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

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3objectlambda-accesspoint.html

CloudformationResource: AWS::S3ObjectLambda::AccessPoint

ExampleMetadata: fixture=_generated

Implements

IInspectable
IAccessPointRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
Back to top Generated by DocFX