Class CfnAccessGrantsLocationProps

Properties for defining a CfnAccessGrantsLocation.

Inheritance

object

CfnAccessGrantsLocationProps

Implements

ICfnAccessGrantsLocationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAccessGrantsLocationProps : ICfnAccessGrantsLocationProps

Syntax (vb)

Public Class CfnAccessGrantsLocationProps Implements ICfnAccessGrantsLocationProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

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.S3;

             var cfnAccessGrantsLocationProps = new CfnAccessGrantsLocationProps {
                 IamRoleArn = "iamRoleArn",
                 LocationScope = "locationScope",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnAccessGrantsLocationProps()

Properties for defining a CfnAccessGrantsLocation.

Properties

IamRoleArn	The Amazon Resource Name (ARN) of the IAM role for the registered location.
LocationScope	The S3 URI path to the location that you are registering.
Tags	The AWS resource tags that you are adding to the S3 Access Grants location.

Constructors

CfnAccessGrantsLocationProps()

Properties for defining a CfnAccessGrantsLocation.

public CfnAccessGrantsLocationProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html

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.S3;

             var cfnAccessGrantsLocationProps = new CfnAccessGrantsLocationProps {
                 IamRoleArn = "iamRoleArn",
                 LocationScope = "locationScope",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

IamRoleArn

The Amazon Resource Name (ARN) of the IAM role for the registered location.

public string? IamRoleArn { get; set; }

Property Value

string

Remarks

S3 Access Grants assumes this role to manage access to the registered location.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-iamrolearn

LocationScope

The S3 URI path to the location that you are registering.

public string? LocationScope { get; set; }

Property Value

string

Remarks

The location scope can be the default S3 location s3:// , the S3 path to a bucket, or the S3 path to a bucket and prefix. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-locationscope

Tags

The AWS resource tags that you are adding to the S3 Access Grants location.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrantslocation.html#cfn-s3-accessgrantslocation-tags

Implements

ICfnAccessGrantsLocationProps