Class CfnAccessGrantProps

Properties for defining a CfnAccessGrant.

Inheritance

object

CfnAccessGrantProps

Implements

ICfnAccessGrantProps

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 CfnAccessGrantProps : ICfnAccessGrantProps

Syntax (vb)

Public Class CfnAccessGrantProps Implements ICfnAccessGrantProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.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 cfnAccessGrantProps = new CfnAccessGrantProps {
                 AccessGrantsLocationId = "accessGrantsLocationId",
                 Grantee = new GranteeProperty {
                     GranteeIdentifier = "granteeIdentifier",
                     GranteeType = "granteeType"
                 },
                 Permission = "permission",

                 // the properties below are optional
                 AccessGrantsLocationConfiguration = new AccessGrantsLocationConfigurationProperty {
                     S3SubPrefix = "s3SubPrefix"
                 },
                 ApplicationArn = "applicationArn",
                 S3PrefixType = "s3PrefixType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnAccessGrantProps()

Properties for defining a CfnAccessGrant.

Properties

AccessGrantsLocationConfiguration	The configuration options of the grant location.
AccessGrantsLocationId	The ID of the registered location to which you are granting access.
ApplicationArn	The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.
Grantee	The user, group, or role to which you are granting access.
Permission	The type of access that you are granting to your S3 data, which can be set to one of the following values: - READ – Grant read-only access to the S3 data.
S3PrefixType	The type of S3SubPrefix .
Tags	The AWS resource tags that you are adding to the access grant.

Constructors

CfnAccessGrantProps()

Properties for defining a CfnAccessGrant.

public CfnAccessGrantProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-accessgrant.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 cfnAccessGrantProps = new CfnAccessGrantProps {
                 AccessGrantsLocationId = "accessGrantsLocationId",
                 Grantee = new GranteeProperty {
                     GranteeIdentifier = "granteeIdentifier",
                     GranteeType = "granteeType"
                 },
                 Permission = "permission",

                 // the properties below are optional
                 AccessGrantsLocationConfiguration = new AccessGrantsLocationConfigurationProperty {
                     S3SubPrefix = "s3SubPrefix"
                 },
                 ApplicationArn = "applicationArn",
                 S3PrefixType = "s3PrefixType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AccessGrantsLocationConfiguration

The configuration options of the grant location.

public object? AccessGrantsLocationConfiguration { get; set; }

Property Value

object

Remarks

The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

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

AccessGrantsLocationId

The ID of the registered location to which you are granting access.

public string AccessGrantsLocationId { get; set; }

Property Value

string

Remarks

S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

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

ApplicationArn

The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.

public string? ApplicationArn { get; set; }

Property Value

string

Remarks

If the grant includes an application ARN, the grantee can only access the S3 data through this application.

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

Grantee

The user, group, or role to which you are granting access.

public object Grantee { get; set; }

Property Value

object

Remarks

You can grant access to an IAM user or role. If you have added your corporate directory to AWS IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

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

Permission

The type of access that you are granting to your S3 data, which can be set to one of the following values: - READ – Grant read-only access to the S3 data.

public string Permission { get; set; }

Property Value

string

Remarks

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

S3PrefixType

The type of S3SubPrefix .

public string? S3PrefixType { get; set; }

Property Value

string

Remarks

The only possible value is Object . Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

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

Tags

The AWS resource tags that you are adding to the access grant.

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-accessgrant.html#cfn-s3-accessgrant-tags

Implements

ICfnAccessGrantProps