Interface CfnAccessGrantProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAccessGrantProps.Jsii$Proxy
CfnAccessGrant
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.s3.*; CfnAccessGrantProps cfnAccessGrantProps = CfnAccessGrantProps.builder() .accessGrantsLocationId("accessGrantsLocationId") .grantee(GranteeProperty.builder() .granteeIdentifier("granteeIdentifier") .granteeType("granteeType") .build()) .permission("permission") // the properties below are optional .accessGrantsLocationConfiguration(AccessGrantsLocationConfigurationProperty.builder() .s3SubPrefix("s3SubPrefix") .build()) .applicationArn("applicationArn") .s3PrefixType("s3PrefixType") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAccessGrantProps
static final class
An implementation forCfnAccessGrantProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAccessGrantProps.Builder
builder()
default Object
The configuration options of the grant location.The ID of the registered location to which you are granting access.default String
The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.The user, group, or role to which you are granting access.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.default String
The type ofS3SubPrefix
.getTags()
The AWS resource tags that you are adding to the access grant.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAccessGrantsLocationId
The ID of the registered location to which you are granting access.S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID
default
to the default locations3://
and assigns an auto-generated ID to other locations that you register.- See Also:
-
getGrantee
The user, group, or role to which you are granting access.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 Also:
-
getPermission
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.WRITE
– Grant write-only access to the S3 data.READWRITE
– Grant both read and write access to the S3 data.
- See Also:
-
getAccessGrantsLocationConfiguration
The configuration options of the grant location.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 Also:
-
getApplicationArn
The Amazon Resource Name (ARN) of an AWS IAM Identity Center application associated with your Identity Center instance.If the grant includes an application ARN, the grantee can only access the S3 data through this application.
- See Also:
-
getS3PrefixType
The type ofS3SubPrefix
.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 Also:
-
getTags
The AWS resource tags that you are adding to the access grant.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 Also:
-
builder
- Returns:
- a
CfnAccessGrantProps.Builder
ofCfnAccessGrantProps
-