Show / Hide Table of Contents

Class CfnAccessPoint

The AWS::S3Outposts::AccessPoint resource specifies an access point and associates it with the specified Amazon S3 on Outposts bucket.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAccessPoint
Implements
IInspectable
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.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String, Nullable<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.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.S3Outposts
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccessPoint : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAccessPoint
    Inherits CfnResource
    Implements IInspectable
Remarks

For more information, see Managing data access with Amazon S3 access points .

S3 on Outposts supports only VPC-style access points.

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

CloudformationResource: AWS::S3Outposts::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.S3Outposts;

var policy;

var cfnAccessPoint = new CfnAccessPoint(this, "MyCfnAccessPoint", new CfnAccessPointProps {
    Bucket = "bucket",
    Name = "name",
    VpcConfiguration = new VpcConfigurationProperty {
        VpcId = "vpcId"
    },

    // the properties below are optional
    Policy = policy
});

Synopsis

Constructors

CfnAccessPoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnAccessPoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

CfnAccessPoint(Construct, String, ICfnAccessPointProps)

Properties

AttrArn

This resource contains the details of the S3 on Outposts bucket access point ARN.

Bucket

The Amazon Resource Name (ARN) of the S3 on Outposts bucket that is associated with this access point.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
Name

The name of this access point.

Policy

The access point policy associated with this access point.

VpcConfiguration

The virtual private cloud (VPC) configuration for this access point, if one exists.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnAccessPoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAccessPoint(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAccessPoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAccessPoint(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAccessPoint(Construct, String, ICfnAccessPointProps)

public CfnAccessPoint(Construct scope, string id, ICfnAccessPointProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnAccessPointProps

Resource properties.

Properties

AttrArn

This resource contains the details of the S3 on Outposts bucket access point ARN.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

This resource is read-only.

CloudformationAttribute: Arn

Bucket

The Amazon Resource Name (ARN) of the S3 on Outposts bucket that is associated with this access point.

public virtual string Bucket { get; set; }
Property Value

System.String

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

Name

The name of this access point.

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

System.String

Policy

The access point policy associated with this access point.

public virtual object Policy { get; set; }
Property Value

System.Object

VpcConfiguration

The virtual private cloud (VPC) configuration for this access point, if one exists.

public virtual object VpcConfiguration { get; set; }
Property Value

System.Object

Methods

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable
Back to top Generated by DocFX