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

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.getAccessGrant

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.

    Using getAccessGrant

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAccessGrant(args: GetAccessGrantArgs, opts?: InvokeOptions): Promise<GetAccessGrantResult>
    function getAccessGrantOutput(args: GetAccessGrantOutputArgs, opts?: InvokeOptions): Output<GetAccessGrantResult>
    def get_access_grant(access_grant_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAccessGrantResult
    def get_access_grant_output(access_grant_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAccessGrantResult]
    func LookupAccessGrant(ctx *Context, args *LookupAccessGrantArgs, opts ...InvokeOption) (*LookupAccessGrantResult, error)
    func LookupAccessGrantOutput(ctx *Context, args *LookupAccessGrantOutputArgs, opts ...InvokeOption) LookupAccessGrantResultOutput

    > Note: This function is named LookupAccessGrant in the Go SDK.

    public static class GetAccessGrant 
    {
        public static Task<GetAccessGrantResult> InvokeAsync(GetAccessGrantArgs args, InvokeOptions? opts = null)
        public static Output<GetAccessGrantResult> Invoke(GetAccessGrantInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccessGrantResult> getAccessGrant(GetAccessGrantArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:s3:getAccessGrant
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccessGrantId string
    The ID assigned to this access grant.
    AccessGrantId string
    The ID assigned to this access grant.
    accessGrantId String
    The ID assigned to this access grant.
    accessGrantId string
    The ID assigned to this access grant.
    access_grant_id str
    The ID assigned to this access grant.
    accessGrantId String
    The ID assigned to this access grant.

    getAccessGrant Result

    The following output properties are available:

    AccessGrantArn string
    The Amazon Resource Name (ARN) of the specified access grant.
    AccessGrantId string
    The ID assigned to this access grant.
    AccessGrantsLocationConfiguration Pulumi.AwsNative.S3.Outputs.AccessGrantsLocationConfiguration
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    AccessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    ApplicationArn string
    The ARN of the application grantees will use to access the location
    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.
    Grantee Pulumi.AwsNative.S3.Outputs.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
    AccessGrantArn string
    The Amazon Resource Name (ARN) of the specified access grant.
    AccessGrantId string
    The ID assigned to this access grant.
    AccessGrantsLocationConfiguration AccessGrantsLocationConfiguration
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    AccessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    ApplicationArn string
    The ARN of the application grantees will use to access the location
    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.
    Grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    Permission AccessGrantPermission
    The level of access to be afforded to the grantee
    accessGrantArn String
    The Amazon Resource Name (ARN) of the specified access grant.
    accessGrantId String
    The ID assigned to this access grant.
    accessGrantsLocationConfiguration AccessGrantsLocationConfiguration
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    accessGrantsLocationId String
    The custom S3 location to be accessed by the grantee
    applicationArn String
    The ARN of the application grantees will use to access the location
    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.
    grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    permission AccessGrantPermission
    The level of access to be afforded to the grantee
    accessGrantArn string
    The Amazon Resource Name (ARN) of the specified access grant.
    accessGrantId string
    The ID assigned to this access grant.
    accessGrantsLocationConfiguration AccessGrantsLocationConfiguration
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    accessGrantsLocationId string
    The custom S3 location to be accessed by the grantee
    applicationArn string
    The ARN of the application grantees will use to access the location
    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.
    grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    permission AccessGrantPermission
    The level of access to be afforded to the grantee
    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.
    access_grants_location_configuration AccessGrantsLocationConfiguration
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    access_grants_location_id str
    The custom S3 location to be accessed by the grantee
    application_arn str
    The ARN of the application grantees will use to access the location
    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.
    grantee AccessGrantGrantee
    The principal who will be granted permission to access S3.
    permission AccessGrantPermission
    The level of access to be afforded to the grantee
    accessGrantArn String
    The Amazon Resource Name (ARN) of the specified access grant.
    accessGrantId String
    The ID assigned to this access grant.
    accessGrantsLocationConfiguration Property Map
    The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
    accessGrantsLocationId String
    The custom S3 location to be accessed by the grantee
    applicationArn String
    The ARN of the application grantees will use to access the location
    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.
    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

    Supporting Types

    AccessGrantGrantee

    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

    AccessGrantPermission

    AccessGrantsLocationConfiguration

    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

    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