Class CfnAccessGrantsLocation
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3.CfnAccessGrantsLocation
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:08.816Z")
@Stability(Stable)
public class CfnAccessGrantsLocation
extends CfnResource
implements IInspectable, ITaggableV2
The
AWS::S3::AccessGrantsLocation
resource creates the S3 data location that you would like to register in your S3 Access Grants instance.
Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following:
- The default S3 location
s3://
- A bucket -
S3://<bucket-name>
- A bucket and prefix -
S3://<bucket-name>/<prefix>
When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy . S3 Access Grants assumes this role to manage access to the location and to vend temporary credentials to grantees or client applications.
- Permissions - You must have the
s3:CreateAccessGrantsLocation
permission to use this resource. - Additional Permissions - You must also have the following permission for the specified IAM role:
iam:PassRole
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.*; CfnAccessGrantsLocation cfnAccessGrantsLocation = CfnAccessGrantsLocation.Builder.create(this, "MyCfnAccessGrantsLocation") .iamRoleArn("iamRoleArn") .locationScope("locationScope") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnAccessGrantsLocation
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnAccessGrantsLocation
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAccessGrantsLocation
(software.amazon.jsii.JsiiObjectRef objRef) CfnAccessGrantsLocation
(software.constructs.Construct scope, String id) CfnAccessGrantsLocation
(software.constructs.Construct scope, String id, CfnAccessGrantsLocationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the location you are registering.The ID of the registered location to which you are granting access.Tag Manager which manages the tags for this resource.The Amazon Resource Name (ARN) of the IAM role for the registered location.The S3 URI path to the location that you are registering.getTags()
The AWS resource tags that you are adding to the S3 Access Grants location.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setIamRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role for the registered location.void
setLocationScope
(String value) The S3 URI path to the location that you are registering.void
The AWS resource tags that you are adding to the S3 Access Grants location.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAccessGrantsLocation
protected CfnAccessGrantsLocation(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAccessGrantsLocation
protected CfnAccessGrantsLocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAccessGrantsLocation
@Stability(Stable) public CfnAccessGrantsLocation(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnAccessGrantsLocationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnAccessGrantsLocation
@Stability(Stable) public CfnAccessGrantsLocation(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAccessGrantsLocationArn
The ARN of the location you are registering. -
getAttrAccessGrantsLocationId
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. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getIamRoleArn
The Amazon Resource Name (ARN) of the IAM role for the registered location. -
setIamRoleArn
The Amazon Resource Name (ARN) of the IAM role for the registered location. -
getLocationScope
The S3 URI path to the location that you are registering. -
setLocationScope
The S3 URI path to the location that you are registering. -
getTags
The AWS resource tags that you are adding to the S3 Access Grants location. -
setTags
The AWS resource tags that you are adding to the S3 Access Grants location.
-