1. Packages
  2. AWS Classic
  3. API Docs
  4. memorydb
  5. Acl

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.memorydb.Acl

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides a MemoryDB ACL.

    More information about users and ACL-s can be found in the MemoryDB User Guide.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.memorydb.Acl("example", {
        name: "my-acl",
        userNames: [
            "my-user-1",
            "my-user-2",
        ],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.memorydb.Acl("example",
        name="my-acl",
        user_names=[
            "my-user-1",
            "my-user-2",
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := memorydb.NewAcl(ctx, "example", &memorydb.AclArgs{
    			Name: pulumi.String("my-acl"),
    			UserNames: pulumi.StringArray{
    				pulumi.String("my-user-1"),
    				pulumi.String("my-user-2"),
    			},
    		})
    		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.MemoryDb.Acl("example", new()
        {
            Name = "my-acl",
            UserNames = new[]
            {
                "my-user-1",
                "my-user-2",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.memorydb.Acl;
    import com.pulumi.aws.memorydb.AclArgs;
    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 Acl("example", AclArgs.builder()
                .name("my-acl")
                .userNames(            
                    "my-user-1",
                    "my-user-2")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:memorydb:Acl
        properties:
          name: my-acl
          userNames:
            - my-user-1
            - my-user-2
    

    Create Acl Resource

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

    Constructor syntax

    new Acl(name: string, args?: AclArgs, opts?: CustomResourceOptions);
    @overload
    def Acl(resource_name: str,
            args: Optional[AclArgs] = None,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Acl(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            user_names: Optional[Sequence[str]] = None)
    func NewAcl(ctx *Context, name string, args *AclArgs, opts ...ResourceOption) (*Acl, error)
    public Acl(string name, AclArgs? args = null, CustomResourceOptions? opts = null)
    public Acl(String name, AclArgs args)
    public Acl(String name, AclArgs args, CustomResourceOptions options)
    
    type: aws:memorydb:Acl
    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 AclArgs
    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 AclArgs
    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 AclArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AclArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AclArgs
    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.

    var aclResource = new Aws.MemoryDb.Acl("aclResource", new()
    {
        Name = "string",
        NamePrefix = "string",
        Tags = 
        {
            { "string", "string" },
        },
        UserNames = new[]
        {
            "string",
        },
    });
    
    example, err := memorydb.NewAcl(ctx, "aclResource", &memorydb.AclArgs{
    	Name:       pulumi.String("string"),
    	NamePrefix: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	UserNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var aclResource = new Acl("aclResource", AclArgs.builder()
        .name("string")
        .namePrefix("string")
        .tags(Map.of("string", "string"))
        .userNames("string")
        .build());
    
    acl_resource = aws.memorydb.Acl("aclResource",
        name="string",
        name_prefix="string",
        tags={
            "string": "string",
        },
        user_names=["string"])
    
    const aclResource = new aws.memorydb.Acl("aclResource", {
        name: "string",
        namePrefix: "string",
        tags: {
            string: "string",
        },
        userNames: ["string"],
    });
    
    type: aws:memorydb:Acl
    properties:
        name: string
        namePrefix: string
        tags:
            string: string
        userNames:
            - string
    

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

    Name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserNames List<string>
    Set of MemoryDB user names to be included in this ACL.
    Name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    UserNames []string
    Set of MemoryDB user names to be included in this ACL.
    name String
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userNames List<String>
    Set of MemoryDB user names to be included in this ACL.
    name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userNames string[]
    Set of MemoryDB user names to be included in this ACL.
    name str
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    user_names Sequence[str]
    Set of MemoryDB user names to be included in this ACL.
    name String
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    userNames List<String>
    Set of MemoryDB user names to be included in this ACL.

    Outputs

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

    Arn string
    The ARN of the ACL.
    Id string
    The provider-assigned unique ID for this managed resource.
    MinimumEngineVersion string
    The minimum engine version supported by the ACL.
    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.

    Arn string
    The ARN of the ACL.
    Id string
    The provider-assigned unique ID for this managed resource.
    MinimumEngineVersion string
    The minimum engine version supported by the ACL.
    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.

    arn String
    The ARN of the ACL.
    id String
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion String
    The minimum engine version supported by the ACL.
    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.

    arn string
    The ARN of the ACL.
    id string
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion string
    The minimum engine version supported by the ACL.
    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.

    arn str
    The ARN of the ACL.
    id str
    The provider-assigned unique ID for this managed resource.
    minimum_engine_version str
    The minimum engine version supported by the ACL.
    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.

    arn String
    The ARN of the ACL.
    id String
    The provider-assigned unique ID for this managed resource.
    minimumEngineVersion String
    The minimum engine version supported by the ACL.
    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 Acl Resource

    Get an existing Acl 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?: AclState, opts?: CustomResourceOptions): Acl
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            minimum_engine_version: Optional[str] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            user_names: Optional[Sequence[str]] = None) -> Acl
    func GetAcl(ctx *Context, name string, id IDInput, state *AclState, opts ...ResourceOption) (*Acl, error)
    public static Acl Get(string name, Input<string> id, AclState? state, CustomResourceOptions? opts = null)
    public static Acl get(String name, Output<String> id, AclState 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:
    Arn string
    The ARN of the ACL.
    MinimumEngineVersion string
    The minimum engine version supported by the ACL.
    Name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. 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.

    UserNames List<string>
    Set of MemoryDB user names to be included in this ACL.
    Arn string
    The ARN of the ACL.
    MinimumEngineVersion string
    The minimum engine version supported by the ACL.
    Name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Tags map[string]string
    A map of tags to assign to the resource. 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.

    UserNames []string
    Set of MemoryDB user names to be included in this ACL.
    arn String
    The ARN of the ACL.
    minimumEngineVersion String
    The minimum engine version supported by the ACL.
    name String
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String,String>
    A map of tags to assign to the resource. 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.

    userNames List<String>
    Set of MemoryDB user names to be included in this ACL.
    arn string
    The ARN of the ACL.
    minimumEngineVersion string
    The minimum engine version supported by the ACL.
    name string
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags {[key: string]: string}
    A map of tags to assign to the resource. 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.

    userNames string[]
    Set of MemoryDB user names to be included in this ACL.
    arn str
    The ARN of the ACL.
    minimum_engine_version str
    The minimum engine version supported by the ACL.
    name str
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Mapping[str, str]
    A map of tags to assign to the resource. 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.

    user_names Sequence[str]
    Set of MemoryDB user names to be included in this ACL.
    arn String
    The ARN of the ACL.
    minimumEngineVersion String
    The minimum engine version supported by the ACL.
    name String
    Name of the ACL. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    tags Map<String>
    A map of tags to assign to the resource. 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.

    userNames List<String>
    Set of MemoryDB user names to be included in this ACL.

    Import

    Using pulumi import, import an ACL using the name. For example:

    $ pulumi import aws:memorydb/acl:Acl example my-acl
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi