Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. s3
  5. AccessGrant

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.s3.AccessGrant

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::S3::AccessGrant resource is an Amazon S3 resource type representing permissions to a specific S3 bucket or prefix hosted in an S3 Access Grants instance.

Create AccessGrant Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AccessGrant(name: string, args: AccessGrantArgs, opts?: CustomResourceOptions);
@overload
def AccessGrant(resource_name: str,
                args: AccessGrantArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AccessGrant(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                access_grants_location_id: Optional[str] = None,
                grantee: Optional[AccessGrantGranteeArgs] = None,
                permission: Optional[AccessGrantPermission] = None,
                access_grants_location_configuration: Optional[AccessGrantsLocationConfigurationArgs] = None,
                application_arn: Optional[str] = None,
                s3_prefix_type: Optional[AccessGrantS3PrefixType] = None,
                tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
func NewAccessGrant(ctx *Context, name string, args AccessGrantArgs, opts ...ResourceOption) (*AccessGrant, error)
public AccessGrant(string name, AccessGrantArgs args, CustomResourceOptions? opts = null)
public AccessGrant(String name, AccessGrantArgs args)
public AccessGrant(String name, AccessGrantArgs args, CustomResourceOptions options)

type: aws-native:s3:AccessGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AccessGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AccessGrantArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AccessGrantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AccessGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AccessGrantArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AccessGrant Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AccessGrant resource accepts the following input properties:

AccessGrantsLocationId This property is required. string
The custom S3 location to be accessed by the grantee
Grantee This property is required. Pulumi.AwsNative.S3.Inputs.AccessGrantGrantee
The principal who will be granted permission to access S3.
Permission This property is required. Pulumi.AwsNative.S3.AccessGrantPermission
The level of access to be afforded to the grantee
AccessGrantsLocationConfiguration Pulumi.AwsNative.S3.Inputs.AccessGrantsLocationConfiguration
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
ApplicationArn string
The ARN of the application grantees will use to access the location
S3PrefixType Pulumi.AwsNative.S3.AccessGrantS3PrefixType
The type of S3SubPrefix.
Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
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.
AccessGrantsLocationId This property is required. string
The custom S3 location to be accessed by the grantee
Grantee This property is required. AccessGrantGranteeArgs
The principal who will be granted permission to access S3.
Permission This property is required. AccessGrantPermission
The level of access to be afforded to the grantee
AccessGrantsLocationConfiguration AccessGrantsLocationConfigurationArgs
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
ApplicationArn string
The ARN of the application grantees will use to access the location
S3PrefixType AccessGrantS3PrefixType
The type of S3SubPrefix.
Tags CreateOnlyTagArgs
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.
accessGrantsLocationId This property is required. String
The custom S3 location to be accessed by the grantee
grantee This property is required. AccessGrantGrantee
The principal who will be granted permission to access S3.
permission This property is required. AccessGrantPermission
The level of access to be afforded to the grantee
accessGrantsLocationConfiguration AccessGrantsLocationConfiguration
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
applicationArn String
The ARN of the application grantees will use to access the location
s3PrefixType AccessGrantS3PrefixType
The type of S3SubPrefix.
tags List<CreateOnlyTag>
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.
accessGrantsLocationId This property is required. string
The custom S3 location to be accessed by the grantee
grantee This property is required. AccessGrantGrantee
The principal who will be granted permission to access S3.
permission This property is required. AccessGrantPermission
The level of access to be afforded to the grantee
accessGrantsLocationConfiguration AccessGrantsLocationConfiguration
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
applicationArn string
The ARN of the application grantees will use to access the location
s3PrefixType AccessGrantS3PrefixType
The type of S3SubPrefix.
tags CreateOnlyTag[]
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.
access_grants_location_id This property is required. str
The custom S3 location to be accessed by the grantee
grantee This property is required. AccessGrantGranteeArgs
The principal who will be granted permission to access S3.
permission This property is required. AccessGrantPermission
The level of access to be afforded to the grantee
access_grants_location_configuration AccessGrantsLocationConfigurationArgs
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
application_arn str
The ARN of the application grantees will use to access the location
s3_prefix_type AccessGrantS3PrefixType
The type of S3SubPrefix.
tags Sequence[CreateOnlyTagArgs]
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.
accessGrantsLocationId This property is required. String
The custom S3 location to be accessed by the grantee
grantee This property is required. Property Map
The principal who will be granted permission to access S3.
permission This property is required. "READ" | "WRITE" | "READWRITE"
The level of access to be afforded to the grantee
accessGrantsLocationConfiguration Property Map
The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
applicationArn String
The ARN of the application grantees will use to access the location
s3PrefixType "Object"
The type of S3SubPrefix.
tags List<Property Map>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the AccessGrant resource produces the following output properties:

AccessGrantArn string
The Amazon Resource Name (ARN) of the specified access grant.
AccessGrantId string
The ID assigned to this access grant.
GrantScope string
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
Id string
The provider-assigned unique ID for this managed resource.
AccessGrantArn string
The Amazon Resource Name (ARN) of the specified access grant.
AccessGrantId string
The ID assigned to this access grant.
GrantScope string
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
Id string
The provider-assigned unique ID for this managed resource.
accessGrantArn String
The Amazon Resource Name (ARN) of the specified access grant.
accessGrantId String
The ID assigned to this access grant.
grantScope String
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
id String
The provider-assigned unique ID for this managed resource.
accessGrantArn string
The Amazon Resource Name (ARN) of the specified access grant.
accessGrantId string
The ID assigned to this access grant.
grantScope string
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
id string
The provider-assigned unique ID for this managed resource.
access_grant_arn str
The Amazon Resource Name (ARN) of the specified access grant.
access_grant_id str
The ID assigned to this access grant.
grant_scope str
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
id str
The provider-assigned unique ID for this managed resource.
accessGrantArn String
The Amazon Resource Name (ARN) of the specified access grant.
accessGrantId String
The ID assigned to this access grant.
grantScope String
The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

AccessGrantGrantee
, AccessGrantGranteeArgs

GranteeIdentifier This property is required. string
The unique identifier of the Grantee
GranteeType This property is required. Pulumi.AwsNative.S3.AccessGrantGranteeGranteeType
Configures the transfer acceleration state for an Amazon S3 bucket.
GranteeIdentifier This property is required. string
The unique identifier of the Grantee
GranteeType This property is required. AccessGrantGranteeGranteeType
Configures the transfer acceleration state for an Amazon S3 bucket.
granteeIdentifier This property is required. String
The unique identifier of the Grantee
granteeType This property is required. AccessGrantGranteeGranteeType
Configures the transfer acceleration state for an Amazon S3 bucket.
granteeIdentifier This property is required. string
The unique identifier of the Grantee
granteeType This property is required. AccessGrantGranteeGranteeType
Configures the transfer acceleration state for an Amazon S3 bucket.
grantee_identifier This property is required. str
The unique identifier of the Grantee
grantee_type This property is required. AccessGrantGranteeGranteeType
Configures the transfer acceleration state for an Amazon S3 bucket.
granteeIdentifier This property is required. String
The unique identifier of the Grantee
granteeType This property is required. "IAM" | "DIRECTORY_USER" | "DIRECTORY_GROUP"
Configures the transfer acceleration state for an Amazon S3 bucket.

AccessGrantGranteeGranteeType
, AccessGrantGranteeGranteeTypeArgs

Iam
IAM
DirectoryUser
DIRECTORY_USER
DirectoryGroup
DIRECTORY_GROUP
AccessGrantGranteeGranteeTypeIam
IAM
AccessGrantGranteeGranteeTypeDirectoryUser
DIRECTORY_USER
AccessGrantGranteeGranteeTypeDirectoryGroup
DIRECTORY_GROUP
Iam
IAM
DirectoryUser
DIRECTORY_USER
DirectoryGroup
DIRECTORY_GROUP
Iam
IAM
DirectoryUser
DIRECTORY_USER
DirectoryGroup
DIRECTORY_GROUP
IAM
IAM
DIRECTORY_USER
DIRECTORY_USER
DIRECTORY_GROUP
DIRECTORY_GROUP
"IAM"
IAM
"DIRECTORY_USER"
DIRECTORY_USER
"DIRECTORY_GROUP"
DIRECTORY_GROUP

AccessGrantPermission
, AccessGrantPermissionArgs

Read
READ
Write
WRITE
Readwrite
READWRITE
AccessGrantPermissionRead
READ
AccessGrantPermissionWrite
WRITE
AccessGrantPermissionReadwrite
READWRITE
Read
READ
Write
WRITE
Readwrite
READWRITE
Read
READ
Write
WRITE
Readwrite
READWRITE
READ
READ
WRITE
WRITE
READWRITE
READWRITE
"READ"
READ
"WRITE"
WRITE
"READWRITE"
READWRITE

AccessGrantS3PrefixType
, AccessGrantS3PrefixTypeArgs

Object
Object
AccessGrantS3PrefixTypeObject
Object
Object
Object
Object
Object
OBJECT
Object
"Object"
Object

AccessGrantsLocationConfiguration
, AccessGrantsLocationConfigurationArgs

S3SubPrefix This property is required. string
The S3 sub prefix of a registered location in your S3 Access Grants instance
S3SubPrefix This property is required. string
The S3 sub prefix of a registered location in your S3 Access Grants instance
s3SubPrefix This property is required. String
The S3 sub prefix of a registered location in your S3 Access Grants instance
s3SubPrefix This property is required. string
The S3 sub prefix of a registered location in your S3 Access Grants instance
s3_sub_prefix This property is required. str
The S3 sub prefix of a registered location in your S3 Access Grants instance
s3SubPrefix This property is required. String
The S3 sub prefix of a registered location in your S3 Access Grants instance

CreateOnlyTag
, CreateOnlyTagArgs

Key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
Value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
Key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
Value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
String
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
String
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
string
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
string
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
str
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
str
The value of the tag
key
This property is required.
Changes to this property will trigger replacement.
String
The key name of the tag
value
This property is required.
Changes to this property will trigger replacement.
String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native