1. Packages
  2. AWS Native
  3. API Docs
  4. s3
  5. AccessGrant

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.s3.AccessGrant

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    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 string
    The unique name of the resource.
    args AccessGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args AccessGrantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessGrantArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const accessGrantResource = new aws_native.s3.AccessGrant("accessGrantResource", {
        accessGrantsLocationId: "string",
        grantee: {
            granteeIdentifier: "string",
            granteeType: aws_native.s3.AccessGrantGranteeGranteeType.Iam,
        },
        permission: aws_native.s3.AccessGrantPermission.Read,
        accessGrantsLocationConfiguration: {
            s3SubPrefix: "string",
        },
        applicationArn: "string",
        s3PrefixType: aws_native.s3.AccessGrantS3PrefixType.Object,
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    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

    The AccessGrant resource accepts the following input properties:

    AccessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    Grantee Pulumi.AwsNative.S3.Inputs.AccessGrantGrantee
    The principal who will be granted permission to access S3.
    Permission 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>
    AccessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    Grantee AccessGrantGranteeArgs
    The principal who will be granted permission to access S3.
    Permission 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
    accessGrantsLocationId String
    The custom S3 location to be accessed by the grantee
    grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    permission 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>
    accessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    permission 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[]
    access_grants_location_id str
    The custom S3 location to be accessed by the grantee
    grantee AccessGrantGranteeArgs
    The principal who will be granted permission to access S3.
    permission 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]
    accessGrantsLocationId String
    The custom S3 location to be accessed by the grantee
    grantee Property Map
    The principal who will be granted permission to access S3.
    permission "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>

    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 string
    The unique identifier of the Grantee
    GranteeType Pulumi.AwsNative.S3.AccessGrantGranteeGranteeType
    Configures the transfer acceleration state for an Amazon S3 bucket.
    GranteeIdentifier string
    The unique identifier of the Grantee
    GranteeType AccessGrantGranteeGranteeType
    Configures the transfer acceleration state for an Amazon S3 bucket.
    granteeIdentifier String
    The unique identifier of the Grantee
    granteeType AccessGrantGranteeGranteeType
    Configures the transfer acceleration state for an Amazon S3 bucket.
    granteeIdentifier string
    The unique identifier of the Grantee
    granteeType AccessGrantGranteeGranteeType
    Configures the transfer acceleration state for an Amazon S3 bucket.
    grantee_identifier str
    The unique identifier of the Grantee
    grantee_type AccessGrantGranteeGranteeType
    Configures the transfer acceleration state for an Amazon S3 bucket.
    granteeIdentifier String
    The unique identifier of the Grantee
    granteeType "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 string
    The S3 sub prefix of a registered location in your S3 Access Grants instance
    S3SubPrefix string
    The S3 sub prefix of a registered location in your S3 Access Grants instance
    s3SubPrefix String
    The S3 sub prefix of a registered location in your S3 Access Grants instance
    s3SubPrefix string
    The S3 sub prefix of a registered location in your S3 Access Grants instance
    s3_sub_prefix str
    The S3 sub prefix of a registered location in your S3 Access Grants instance
    s3SubPrefix String
    The S3 sub prefix of a registered location in your S3 Access Grants instance

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi