Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. s3control
  5. AccessGrantsInstance
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.s3control.AccessGrantsInstance

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a resource to manage an S3 Access Grants instance, which serves as a logical grouping for access grants. You can have one S3 Access Grants instance per Region in your account.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3control.AccessGrantsInstance("example", {});

    import pulumi
import pulumi_aws as aws

example = aws.s3control.AccessGrantsInstance("example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3control"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3control.NewAccessGrantsInstance(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3Control.AccessGrantsInstance("example");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3control.AccessGrantsInstance;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AccessGrantsInstance("example");

    }
}

    resources:
  example:
    type: aws:s3control:AccessGrantsInstance

    AWS IAM Identity Center

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3control.AccessGrantsInstance("example", {identityCenterArn: "arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d"});

    import pulumi
import pulumi_aws as aws

example = aws.s3control.AccessGrantsInstance("example", identity_center_arn="arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3control"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := s3control.NewAccessGrantsInstance(ctx, "example", &s3control.AccessGrantsInstanceArgs{
			IdentityCenterArn: pulumi.String("arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.S3Control.AccessGrantsInstance("example", new()
    {
        IdentityCenterArn = "arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3control.AccessGrantsInstance;
import com.pulumi.aws.s3control.AccessGrantsInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AccessGrantsInstance("example", AccessGrantsInstanceArgs.builder()
            .identityCenterArn("arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d")
            .build());

    }
}

    resources:
  example:
    type: aws:s3control:AccessGrantsInstance
    properties:
      identityCenterArn: arn:aws:sso:::instance/ssoins-890759e9c7bfdc1d

    Create AccessGrantsInstance Resource

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

    Constructor syntax

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

@overload
def AccessGrantsInstance(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_id: Optional[str] = None,
                         identity_center_arn: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
    func NewAccessGrantsInstance(ctx *Context, name string, args *AccessGrantsInstanceArgs, opts ...ResourceOption) (*AccessGrantsInstance, error)
    public AccessGrantsInstance(string name, AccessGrantsInstanceArgs? args = null, CustomResourceOptions? opts = null)
    public AccessGrantsInstance(String name, AccessGrantsInstanceArgs args)
public AccessGrantsInstance(String name, AccessGrantsInstanceArgs args, CustomResourceOptions options)

    type: aws:s3control:AccessGrantsInstance
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 AccessGrantsInstanceArgs
    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 AccessGrantsInstanceArgs
    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 AccessGrantsInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessGrantsInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessGrantsInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var accessGrantsInstanceResource = new Aws.S3Control.AccessGrantsInstance("accessGrantsInstanceResource", new()
{
    AccountId = "string",
    IdentityCenterArn = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := s3control.NewAccessGrantsInstance(ctx, "accessGrantsInstanceResource", &s3control.AccessGrantsInstanceArgs{
	AccountId:         pulumi.String("string"),
	IdentityCenterArn: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var accessGrantsInstanceResource = new AccessGrantsInstance("accessGrantsInstanceResource", AccessGrantsInstanceArgs.builder()
    .accountId("string")
    .identityCenterArn("string")
    .tags(Map.of("string", "string"))
    .build());

    access_grants_instance_resource = aws.s3control.AccessGrantsInstance("accessGrantsInstanceResource",
    account_id="string",
    identity_center_arn="string",
    tags={
        "string": "string",
    })

    const accessGrantsInstanceResource = new aws.s3control.AccessGrantsInstance("accessGrantsInstanceResource", {
    accountId: "string",
    identityCenterArn: "string",
    tags: {
        string: "string",
    },
});

    type: aws:s3control:AccessGrantsInstance
properties:
    accountId: string
    identityCenterArn: string
    tags:
        string: string

    AccessGrantsInstance 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 AccessGrantsInstance resource accepts the following input properties:

    AccountId string
    IdentityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AccountId string
    IdentityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accountId String
    identityCenterArn String
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accountId string
    identityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    account_id str
    identity_center_arn str
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    accountId String
    identityCenterArn String
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    AccessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    AccessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AccessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    AccessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn String
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId String
    Unique ID of the S3 Access Grants instance.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    id string
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    access_grants_instance_arn str
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    access_grants_instance_id str
    Unique ID of the S3 Access Grants instance.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_center_application_arn str
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn String
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId String
    Unique ID of the S3 Access Grants instance.
    id String
    The provider-assigned unique ID for this managed resource.
    identityCenterApplicationArn String
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing AccessGrantsInstance Resource

    Get an existing AccessGrantsInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccessGrantsInstanceState, opts?: CustomResourceOptions): AccessGrantsInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_grants_instance_arn: Optional[str] = None,
        access_grants_instance_id: Optional[str] = None,
        account_id: Optional[str] = None,
        identity_center_application_arn: Optional[str] = None,
        identity_center_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> AccessGrantsInstance
    func GetAccessGrantsInstance(ctx *Context, name string, id IDInput, state *AccessGrantsInstanceState, opts ...ResourceOption) (*AccessGrantsInstance, error)
    public static AccessGrantsInstance Get(string name, Input<string> id, AccessGrantsInstanceState? state, CustomResourceOptions? opts = null)
    public static AccessGrantsInstance get(String name, Output<String> id, AccessGrantsInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    AccessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    AccountId string
    IdentityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    IdentityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AccessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    AccessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    AccountId string
    IdentityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    IdentityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn String
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId String
    Unique ID of the S3 Access Grants instance.
    accountId String
    identityCenterApplicationArn String
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    identityCenterArn String
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn string
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId string
    Unique ID of the S3 Access Grants instance.
    accountId string
    identityCenterApplicationArn string
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    identityCenterArn string
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    access_grants_instance_arn str
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    access_grants_instance_id str
    Unique ID of the S3 Access Grants instance.
    account_id str
    identity_center_application_arn str
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    identity_center_arn str
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    accessGrantsInstanceArn String
    Amazon Resource Name (ARN) of the S3 Access Grants instance.
    accessGrantsInstanceId String
    Unique ID of the S3 Access Grants instance.
    accountId String
    identityCenterApplicationArn String
    The ARN of the AWS IAM Identity Center instance application; a subresource of the original Identity Center instance.
    identityCenterArn String
    The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import S3 Access Grants instances using the account_id. For example:

    $ pulumi import aws:s3control/accessGrantsInstance:AccessGrantsInstance example 123456789012

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws