Interface ICfnAccessGrantProps
Properties for defining a CfnAccessGrant
.
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAccessGrantProps
Syntax (vb)
Public Interface 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
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: - |
S3PrefixType | The type of |
Tags | The AWS resource tags that you are adding to the access grant. |
Properties
AccessGrantsLocationConfiguration
The configuration options of the grant location.
virtual object AccessGrantsLocationConfiguration { get; }
Property Value
System.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.
AccessGrantsLocationId
The ID of the registered location to which you are granting access.
string AccessGrantsLocationId { get; }
Property Value
System.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.
ApplicationArn
The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.
virtual string ApplicationArn { get; }
Property Value
System.String
Remarks
If the grant includes an application ARN, the grantee can only access the S3 data through this application.
Grantee
The user, group, or role to which you are granting access.
object Grantee { get; }
Property Value
System.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.
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.
string Permission { get; }
Property Value
System.String
Remarks
S3PrefixType
The type of S3SubPrefix
.
virtual string S3PrefixType { get; }
Property Value
System.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.
Tags
The AWS resource tags that you are adding to the access grant.
virtual ICfnTag[] Tags { get; }
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.