Documentation
¶
Index ¶
- type Acl
- type AclArgs
- type AclArray
- type AclArrayInput
- type AclArrayOutput
- type AclInput
- type AclMap
- type AclMapInput
- type AclMapOutput
- type AclOutput
- type AclState
- type Cluster
- type ClusterArgs
- type ClusterArray
- type ClusterArrayInput
- type ClusterArrayOutput
- type ClusterClusterEndpoint
- type ClusterClusterEndpointArgs
- type ClusterClusterEndpointArray
- func (ClusterClusterEndpointArray) ElementType() reflect.Type
- func (i ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutput() ClusterClusterEndpointArrayOutput
- func (i ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterClusterEndpointArrayOutput
- type ClusterClusterEndpointArrayInput
- type ClusterClusterEndpointArrayOutput
- func (ClusterClusterEndpointArrayOutput) ElementType() reflect.Type
- func (o ClusterClusterEndpointArrayOutput) Index(i pulumi.IntInput) ClusterClusterEndpointOutput
- func (o ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutput() ClusterClusterEndpointArrayOutput
- func (o ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterClusterEndpointArrayOutput
- type ClusterClusterEndpointInput
- type ClusterClusterEndpointOutput
- func (o ClusterClusterEndpointOutput) Address() pulumi.StringPtrOutput
- func (ClusterClusterEndpointOutput) ElementType() reflect.Type
- func (o ClusterClusterEndpointOutput) Port() pulumi.IntPtrOutput
- func (o ClusterClusterEndpointOutput) ToClusterClusterEndpointOutput() ClusterClusterEndpointOutput
- func (o ClusterClusterEndpointOutput) ToClusterClusterEndpointOutputWithContext(ctx context.Context) ClusterClusterEndpointOutput
- type ClusterInput
- type ClusterMap
- type ClusterMapInput
- type ClusterMapOutput
- type ClusterOutput
- type ClusterShard
- type ClusterShardArgs
- type ClusterShardArray
- type ClusterShardArrayInput
- type ClusterShardArrayOutput
- func (ClusterShardArrayOutput) ElementType() reflect.Type
- func (o ClusterShardArrayOutput) Index(i pulumi.IntInput) ClusterShardOutput
- func (o ClusterShardArrayOutput) ToClusterShardArrayOutput() ClusterShardArrayOutput
- func (o ClusterShardArrayOutput) ToClusterShardArrayOutputWithContext(ctx context.Context) ClusterShardArrayOutput
- type ClusterShardInput
- type ClusterShardNode
- type ClusterShardNodeArgs
- type ClusterShardNodeArray
- type ClusterShardNodeArrayInput
- type ClusterShardNodeArrayOutput
- func (ClusterShardNodeArrayOutput) ElementType() reflect.Type
- func (o ClusterShardNodeArrayOutput) Index(i pulumi.IntInput) ClusterShardNodeOutput
- func (o ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutput() ClusterShardNodeArrayOutput
- func (o ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutputWithContext(ctx context.Context) ClusterShardNodeArrayOutput
- type ClusterShardNodeEndpoint
- type ClusterShardNodeEndpointArgs
- func (ClusterShardNodeEndpointArgs) ElementType() reflect.Type
- func (i ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutput() ClusterShardNodeEndpointOutput
- func (i ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutputWithContext(ctx context.Context) ClusterShardNodeEndpointOutput
- type ClusterShardNodeEndpointArray
- func (ClusterShardNodeEndpointArray) ElementType() reflect.Type
- func (i ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutput() ClusterShardNodeEndpointArrayOutput
- func (i ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutputWithContext(ctx context.Context) ClusterShardNodeEndpointArrayOutput
- type ClusterShardNodeEndpointArrayInput
- type ClusterShardNodeEndpointArrayOutput
- func (ClusterShardNodeEndpointArrayOutput) ElementType() reflect.Type
- func (o ClusterShardNodeEndpointArrayOutput) Index(i pulumi.IntInput) ClusterShardNodeEndpointOutput
- func (o ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutput() ClusterShardNodeEndpointArrayOutput
- func (o ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutputWithContext(ctx context.Context) ClusterShardNodeEndpointArrayOutput
- type ClusterShardNodeEndpointInput
- type ClusterShardNodeEndpointOutput
- func (o ClusterShardNodeEndpointOutput) Address() pulumi.StringPtrOutput
- func (ClusterShardNodeEndpointOutput) ElementType() reflect.Type
- func (o ClusterShardNodeEndpointOutput) Port() pulumi.IntPtrOutput
- func (o ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutput() ClusterShardNodeEndpointOutput
- func (o ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutputWithContext(ctx context.Context) ClusterShardNodeEndpointOutput
- type ClusterShardNodeInput
- type ClusterShardNodeOutput
- func (o ClusterShardNodeOutput) AvailabilityZone() pulumi.StringPtrOutput
- func (o ClusterShardNodeOutput) CreateTime() pulumi.StringPtrOutput
- func (ClusterShardNodeOutput) ElementType() reflect.Type
- func (o ClusterShardNodeOutput) Endpoints() ClusterShardNodeEndpointArrayOutput
- func (o ClusterShardNodeOutput) Name() pulumi.StringPtrOutput
- func (o ClusterShardNodeOutput) ToClusterShardNodeOutput() ClusterShardNodeOutput
- func (o ClusterShardNodeOutput) ToClusterShardNodeOutputWithContext(ctx context.Context) ClusterShardNodeOutput
- type ClusterShardOutput
- func (ClusterShardOutput) ElementType() reflect.Type
- func (o ClusterShardOutput) Name() pulumi.StringPtrOutput
- func (o ClusterShardOutput) Nodes() ClusterShardNodeArrayOutput
- func (o ClusterShardOutput) NumNodes() pulumi.IntPtrOutput
- func (o ClusterShardOutput) Slots() pulumi.StringPtrOutput
- func (o ClusterShardOutput) ToClusterShardOutput() ClusterShardOutput
- func (o ClusterShardOutput) ToClusterShardOutputWithContext(ctx context.Context) ClusterShardOutput
- type ClusterState
- type ParameterGroup
- type ParameterGroupArgs
- type ParameterGroupArray
- type ParameterGroupArrayInput
- type ParameterGroupArrayOutput
- func (ParameterGroupArrayOutput) ElementType() reflect.Type
- func (o ParameterGroupArrayOutput) Index(i pulumi.IntInput) ParameterGroupOutput
- func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
- func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
- type ParameterGroupInput
- type ParameterGroupMap
- type ParameterGroupMapInput
- type ParameterGroupMapOutput
- func (ParameterGroupMapOutput) ElementType() reflect.Type
- func (o ParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ParameterGroupOutput
- func (o ParameterGroupMapOutput) ToParameterGroupMapOutput() ParameterGroupMapOutput
- func (o ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
- type ParameterGroupOutput
- type ParameterGroupParameter
- type ParameterGroupParameterArgs
- type ParameterGroupParameterArray
- func (ParameterGroupParameterArray) ElementType() reflect.Type
- func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
- func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
- type ParameterGroupParameterArrayInput
- type ParameterGroupParameterArrayOutput
- func (ParameterGroupParameterArrayOutput) ElementType() reflect.Type
- func (o ParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ParameterGroupParameterOutput
- func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
- func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
- type ParameterGroupParameterInput
- type ParameterGroupParameterOutput
- func (ParameterGroupParameterOutput) ElementType() reflect.Type
- func (o ParameterGroupParameterOutput) Name() pulumi.StringOutput
- func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput
- func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput
- func (o ParameterGroupParameterOutput) Value() pulumi.StringOutput
- type ParameterGroupState
- type Snapshot
- type SnapshotArgs
- type SnapshotArray
- type SnapshotArrayInput
- type SnapshotArrayOutput
- type SnapshotClusterConfiguration
- type SnapshotClusterConfigurationArgs
- func (SnapshotClusterConfigurationArgs) ElementType() reflect.Type
- func (i SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutput() SnapshotClusterConfigurationOutput
- func (i SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutputWithContext(ctx context.Context) SnapshotClusterConfigurationOutput
- type SnapshotClusterConfigurationArray
- func (SnapshotClusterConfigurationArray) ElementType() reflect.Type
- func (i SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutput() SnapshotClusterConfigurationArrayOutput
- func (i SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutputWithContext(ctx context.Context) SnapshotClusterConfigurationArrayOutput
- type SnapshotClusterConfigurationArrayInput
- type SnapshotClusterConfigurationArrayOutput
- func (SnapshotClusterConfigurationArrayOutput) ElementType() reflect.Type
- func (o SnapshotClusterConfigurationArrayOutput) Index(i pulumi.IntInput) SnapshotClusterConfigurationOutput
- func (o SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutput() SnapshotClusterConfigurationArrayOutput
- func (o SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutputWithContext(ctx context.Context) SnapshotClusterConfigurationArrayOutput
- type SnapshotClusterConfigurationInput
- type SnapshotClusterConfigurationOutput
- func (o SnapshotClusterConfigurationOutput) Description() pulumi.StringPtrOutput
- func (SnapshotClusterConfigurationOutput) ElementType() reflect.Type
- func (o SnapshotClusterConfigurationOutput) EngineVersion() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) MaintenanceWindow() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) Name() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) NodeType() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) NumShards() pulumi.IntPtrOutput
- func (o SnapshotClusterConfigurationOutput) ParameterGroupName() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) Port() pulumi.IntPtrOutput
- func (o SnapshotClusterConfigurationOutput) SnapshotRetentionLimit() pulumi.IntPtrOutput
- func (o SnapshotClusterConfigurationOutput) SnapshotWindow() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) SubnetGroupName() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutput() SnapshotClusterConfigurationOutput
- func (o SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutputWithContext(ctx context.Context) SnapshotClusterConfigurationOutput
- func (o SnapshotClusterConfigurationOutput) TopicArn() pulumi.StringPtrOutput
- func (o SnapshotClusterConfigurationOutput) VpcId() pulumi.StringPtrOutput
- type SnapshotInput
- type SnapshotMap
- type SnapshotMapInput
- type SnapshotMapOutput
- type SnapshotOutput
- type SnapshotState
- type SubnetGroup
- type SubnetGroupArgs
- type SubnetGroupArray
- type SubnetGroupArrayInput
- type SubnetGroupArrayOutput
- func (SubnetGroupArrayOutput) ElementType() reflect.Type
- func (o SubnetGroupArrayOutput) Index(i pulumi.IntInput) SubnetGroupOutput
- func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
- func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
- type SubnetGroupInput
- type SubnetGroupMap
- type SubnetGroupMapInput
- type SubnetGroupMapOutput
- func (SubnetGroupMapOutput) ElementType() reflect.Type
- func (o SubnetGroupMapOutput) MapIndex(k pulumi.StringInput) SubnetGroupOutput
- func (o SubnetGroupMapOutput) ToSubnetGroupMapOutput() SubnetGroupMapOutput
- func (o SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
- type SubnetGroupOutput
- type SubnetGroupState
- type User
- type UserArgs
- type UserArray
- type UserArrayInput
- type UserArrayOutput
- type UserAuthenticationMode
- type UserAuthenticationModeArgs
- func (UserAuthenticationModeArgs) ElementType() reflect.Type
- func (i UserAuthenticationModeArgs) ToUserAuthenticationModeOutput() UserAuthenticationModeOutput
- func (i UserAuthenticationModeArgs) ToUserAuthenticationModeOutputWithContext(ctx context.Context) UserAuthenticationModeOutput
- func (i UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
- func (i UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
- type UserAuthenticationModeInput
- type UserAuthenticationModeOutput
- func (UserAuthenticationModeOutput) ElementType() reflect.Type
- func (o UserAuthenticationModeOutput) PasswordCount() pulumi.IntPtrOutput
- func (o UserAuthenticationModeOutput) Passwords() pulumi.StringArrayOutput
- func (o UserAuthenticationModeOutput) ToUserAuthenticationModeOutput() UserAuthenticationModeOutput
- func (o UserAuthenticationModeOutput) ToUserAuthenticationModeOutputWithContext(ctx context.Context) UserAuthenticationModeOutput
- func (o UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
- func (o UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
- func (o UserAuthenticationModeOutput) Type() pulumi.StringOutput
- type UserAuthenticationModePtrInput
- type UserAuthenticationModePtrOutput
- func (o UserAuthenticationModePtrOutput) Elem() UserAuthenticationModeOutput
- func (UserAuthenticationModePtrOutput) ElementType() reflect.Type
- func (o UserAuthenticationModePtrOutput) PasswordCount() pulumi.IntPtrOutput
- func (o UserAuthenticationModePtrOutput) Passwords() pulumi.StringArrayOutput
- func (o UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
- func (o UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
- func (o UserAuthenticationModePtrOutput) Type() pulumi.StringPtrOutput
- type UserInput
- type UserMap
- type UserMapInput
- type UserMapOutput
- type UserOutput
- type UserState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Acl ¶
type Acl struct { pulumi.CustomResourceState // The ARN of the ACL. Arn pulumi.StringOutput `pulumi:"arn"` // The minimum engine version supported by the ACL. MinimumEngineVersion pulumi.StringOutput `pulumi:"minimumEngineVersion"` Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // Set of MemoryDB user names to be included in this ACL. UserNames pulumi.StringArrayOutput `pulumi:"userNames"` }
Provides a MemoryDB ACL.
More information about users and ACL-s can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/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{ UserNames: pulumi.StringArray{ pulumi.String("my-user-1"), pulumi.String("my-user-2"), }, }) if err != nil { return err } return nil }) }
```
## Import
Use the `name` to import an ACL. For example
```sh
$ pulumi import aws:memorydb/acl:Acl example my-acl
```
func GetAcl ¶
func GetAcl(ctx *pulumi.Context, name string, id pulumi.IDInput, state *AclState, opts ...pulumi.ResourceOption) (*Acl, error)
GetAcl gets an existing Acl resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAcl ¶
func NewAcl(ctx *pulumi.Context, name string, args *AclArgs, opts ...pulumi.ResourceOption) (*Acl, error)
NewAcl registers a new resource with the given unique name, arguments, and options.
func (*Acl) ElementType ¶
func (*Acl) ToAclOutput ¶
type AclArgs ¶
type AclArgs struct { Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // Set of MemoryDB user names to be included in this ACL. UserNames pulumi.StringArrayInput }
The set of arguments for constructing a Acl resource.
func (AclArgs) ElementType ¶
type AclArray ¶
type AclArray []AclInput
func (AclArray) ElementType ¶
func (AclArray) ToAclArrayOutput ¶
func (i AclArray) ToAclArrayOutput() AclArrayOutput
func (AclArray) ToAclArrayOutputWithContext ¶
func (i AclArray) ToAclArrayOutputWithContext(ctx context.Context) AclArrayOutput
type AclArrayInput ¶
type AclArrayInput interface { pulumi.Input ToAclArrayOutput() AclArrayOutput ToAclArrayOutputWithContext(context.Context) AclArrayOutput }
AclArrayInput is an input type that accepts AclArray and AclArrayOutput values. You can construct a concrete instance of `AclArrayInput` via:
AclArray{ AclArgs{...} }
type AclArrayOutput ¶
type AclArrayOutput struct{ *pulumi.OutputState }
func (AclArrayOutput) ElementType ¶
func (AclArrayOutput) ElementType() reflect.Type
func (AclArrayOutput) ToAclArrayOutput ¶
func (o AclArrayOutput) ToAclArrayOutput() AclArrayOutput
func (AclArrayOutput) ToAclArrayOutputWithContext ¶
func (o AclArrayOutput) ToAclArrayOutputWithContext(ctx context.Context) AclArrayOutput
type AclMap ¶
func (AclMap) ElementType ¶
func (AclMap) ToAclMapOutput ¶
func (i AclMap) ToAclMapOutput() AclMapOutput
func (AclMap) ToAclMapOutputWithContext ¶
func (i AclMap) ToAclMapOutputWithContext(ctx context.Context) AclMapOutput
type AclMapInput ¶
type AclMapInput interface { pulumi.Input ToAclMapOutput() AclMapOutput ToAclMapOutputWithContext(context.Context) AclMapOutput }
AclMapInput is an input type that accepts AclMap and AclMapOutput values. You can construct a concrete instance of `AclMapInput` via:
AclMap{ "key": AclArgs{...} }
type AclMapOutput ¶
type AclMapOutput struct{ *pulumi.OutputState }
func (AclMapOutput) ElementType ¶
func (AclMapOutput) ElementType() reflect.Type
func (AclMapOutput) MapIndex ¶
func (o AclMapOutput) MapIndex(k pulumi.StringInput) AclOutput
func (AclMapOutput) ToAclMapOutput ¶
func (o AclMapOutput) ToAclMapOutput() AclMapOutput
func (AclMapOutput) ToAclMapOutputWithContext ¶
func (o AclMapOutput) ToAclMapOutputWithContext(ctx context.Context) AclMapOutput
type AclOutput ¶
type AclOutput struct{ *pulumi.OutputState }
func (AclOutput) ElementType ¶
func (AclOutput) ToAclOutput ¶
type AclState ¶
type AclState struct { // The ARN of the ACL. Arn pulumi.StringPtrInput // The minimum engine version supported by the ACL. MinimumEngineVersion pulumi.StringPtrInput Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // Set of MemoryDB user names to be included in this ACL. UserNames pulumi.StringArrayInput }
func (AclState) ElementType ¶
type Cluster ¶
type Cluster struct { pulumi.CustomResourceState // The name of the Access Control List to associate with the cluster. AclName pulumi.StringOutput `pulumi:"aclName"` // The ARN of the cluster. // * `clusterEndpoint` Arn pulumi.StringOutput `pulumi:"arn"` // When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`. AutoMinorVersionUpgrade pulumi.BoolPtrOutput `pulumi:"autoMinorVersionUpgrade"` ClusterEndpoints ClusterClusterEndpointArrayOutput `pulumi:"clusterEndpoints"` Description pulumi.StringPtrOutput `pulumi:"description"` // Patch version number of the Redis engine used by the cluster. EnginePatchVersion pulumi.StringOutput `pulumi:"enginePatchVersion"` // Version number of the Redis engine to be used for the cluster. Downgrades are not supported. EngineVersion pulumi.StringOutput `pulumi:"engineVersion"` // Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made. FinalSnapshotName pulumi.StringPtrOutput `pulumi:"finalSnapshotName"` // ARN of the KMS key used to encrypt the cluster at rest. KmsKeyArn pulumi.StringPtrOutput `pulumi:"kmsKeyArn"` // Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:23:00-mon:01:30`. MaintenanceWindow pulumi.StringOutput `pulumi:"maintenanceWindow"` // Name of this node. // * `endpoint` Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // The compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.html). NodeType pulumi.StringOutput `pulumi:"nodeType"` // The number of replicas to apply to each shard, up to a maximum of 5. Defaults to `1` (i.e. 2 nodes per shard). NumReplicasPerShard pulumi.IntPtrOutput `pulumi:"numReplicasPerShard"` // The number of shards in the cluster. Defaults to `1`. NumShards pulumi.IntPtrOutput `pulumi:"numShards"` // The name of the parameter group associated with the cluster. ParameterGroupName pulumi.StringOutput `pulumi:"parameterGroupName"` // The port number on which each of the nodes accepts connections. Defaults to `6379`. Port pulumi.IntOutput `pulumi:"port"` // Set of VPC Security Group ID-s to associate with this cluster. SecurityGroupIds pulumi.StringArrayOutput `pulumi:"securityGroupIds"` // Set of shards in this cluster. Shards ClusterShardArrayOutput `pulumi:"shards"` // List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas. SnapshotArns pulumi.StringPtrOutput `pulumi:"snapshotArns"` // The name of a snapshot from which to restore data into the new cluster. SnapshotName pulumi.StringPtrOutput `pulumi:"snapshotName"` // The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to `0`, automatic backups are disabled. Defaults to `0`. SnapshotRetentionLimit pulumi.IntOutput `pulumi:"snapshotRetentionLimit"` // The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: `05:00-09:00`. SnapshotWindow pulumi.StringOutput `pulumi:"snapshotWindow"` // ARN of the SNS topic to which cluster notifications are sent. SnsTopicArn pulumi.StringPtrOutput `pulumi:"snsTopicArn"` // The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets. SubnetGroupName pulumi.StringOutput `pulumi:"subnetGroupName"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // A flag to enable in-transit encryption on the cluster. When set to `false`, the `aclName` must be `open-access`. Defaults to `true`. TlsEnabled pulumi.BoolPtrOutput `pulumi:"tlsEnabled"` }
Provides a MemoryDB Cluster.
More information about MemoryDB can be found in the [Developer Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/what-is-memorydb-for-redis.html).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/memorydb" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := memorydb.NewCluster(ctx, "example", &memorydb.ClusterArgs{ AclName: pulumi.String("open-access"), NodeType: pulumi.String("db.t4g.small"), NumShards: pulumi.Int(2), SecurityGroupIds: pulumi.StringArray{ pulumi.Any(aws_security_group.Example.Id), }, SnapshotRetentionLimit: pulumi.Int(7), SubnetGroupName: pulumi.Any(aws_memorydb_subnet_group.Example.Id), }) if err != nil { return err } return nil }) }
```
## Import
Use the `name` to import a cluster. For example
```sh
$ pulumi import aws:memorydb/cluster:Cluster example my-cluster
```
func GetCluster ¶
func GetCluster(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ClusterState, opts ...pulumi.ResourceOption) (*Cluster, error)
GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewCluster ¶
func NewCluster(ctx *pulumi.Context, name string, args *ClusterArgs, opts ...pulumi.ResourceOption) (*Cluster, error)
NewCluster registers a new resource with the given unique name, arguments, and options.
func (*Cluster) ElementType ¶
func (*Cluster) ToClusterOutput ¶
func (i *Cluster) ToClusterOutput() ClusterOutput
func (*Cluster) ToClusterOutputWithContext ¶
func (i *Cluster) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
type ClusterArgs ¶
type ClusterArgs struct { // The name of the Access Control List to associate with the cluster. AclName pulumi.StringInput // When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`. AutoMinorVersionUpgrade pulumi.BoolPtrInput Description pulumi.StringPtrInput // Version number of the Redis engine to be used for the cluster. Downgrades are not supported. EngineVersion pulumi.StringPtrInput // Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made. FinalSnapshotName pulumi.StringPtrInput // ARN of the KMS key used to encrypt the cluster at rest. KmsKeyArn pulumi.StringPtrInput // Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:23:00-mon:01:30`. MaintenanceWindow pulumi.StringPtrInput // Name of this node. // * `endpoint` Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // The compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.html). NodeType pulumi.StringInput // The number of replicas to apply to each shard, up to a maximum of 5. Defaults to `1` (i.e. 2 nodes per shard). NumReplicasPerShard pulumi.IntPtrInput // The number of shards in the cluster. Defaults to `1`. NumShards pulumi.IntPtrInput // The name of the parameter group associated with the cluster. ParameterGroupName pulumi.StringPtrInput // The port number on which each of the nodes accepts connections. Defaults to `6379`. Port pulumi.IntPtrInput // Set of VPC Security Group ID-s to associate with this cluster. SecurityGroupIds pulumi.StringArrayInput // List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas. SnapshotArns pulumi.StringPtrInput // The name of a snapshot from which to restore data into the new cluster. SnapshotName pulumi.StringPtrInput // The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to `0`, automatic backups are disabled. Defaults to `0`. SnapshotRetentionLimit pulumi.IntPtrInput // The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: `05:00-09:00`. SnapshotWindow pulumi.StringPtrInput // ARN of the SNS topic to which cluster notifications are sent. SnsTopicArn pulumi.StringPtrInput // The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets. SubnetGroupName pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // A flag to enable in-transit encryption on the cluster. When set to `false`, the `aclName` must be `open-access`. Defaults to `true`. TlsEnabled pulumi.BoolPtrInput }
The set of arguments for constructing a Cluster resource.
func (ClusterArgs) ElementType ¶
func (ClusterArgs) ElementType() reflect.Type
type ClusterArray ¶
type ClusterArray []ClusterInput
func (ClusterArray) ElementType ¶
func (ClusterArray) ElementType() reflect.Type
func (ClusterArray) ToClusterArrayOutput ¶
func (i ClusterArray) ToClusterArrayOutput() ClusterArrayOutput
func (ClusterArray) ToClusterArrayOutputWithContext ¶
func (i ClusterArray) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput
type ClusterArrayInput ¶
type ClusterArrayInput interface { pulumi.Input ToClusterArrayOutput() ClusterArrayOutput ToClusterArrayOutputWithContext(context.Context) ClusterArrayOutput }
ClusterArrayInput is an input type that accepts ClusterArray and ClusterArrayOutput values. You can construct a concrete instance of `ClusterArrayInput` via:
ClusterArray{ ClusterArgs{...} }
type ClusterArrayOutput ¶
type ClusterArrayOutput struct{ *pulumi.OutputState }
func (ClusterArrayOutput) ElementType ¶
func (ClusterArrayOutput) ElementType() reflect.Type
func (ClusterArrayOutput) Index ¶
func (o ClusterArrayOutput) Index(i pulumi.IntInput) ClusterOutput
func (ClusterArrayOutput) ToClusterArrayOutput ¶
func (o ClusterArrayOutput) ToClusterArrayOutput() ClusterArrayOutput
func (ClusterArrayOutput) ToClusterArrayOutputWithContext ¶
func (o ClusterArrayOutput) ToClusterArrayOutputWithContext(ctx context.Context) ClusterArrayOutput
type ClusterClusterEndpoint ¶
type ClusterClusterEndpointArgs ¶
type ClusterClusterEndpointArgs struct { // DNS hostname of the node. Address pulumi.StringPtrInput `pulumi:"address"` // The port number on which each of the nodes accepts connections. Defaults to `6379`. Port pulumi.IntPtrInput `pulumi:"port"` }
func (ClusterClusterEndpointArgs) ElementType ¶
func (ClusterClusterEndpointArgs) ElementType() reflect.Type
func (ClusterClusterEndpointArgs) ToClusterClusterEndpointOutput ¶
func (i ClusterClusterEndpointArgs) ToClusterClusterEndpointOutput() ClusterClusterEndpointOutput
func (ClusterClusterEndpointArgs) ToClusterClusterEndpointOutputWithContext ¶
func (i ClusterClusterEndpointArgs) ToClusterClusterEndpointOutputWithContext(ctx context.Context) ClusterClusterEndpointOutput
type ClusterClusterEndpointArray ¶
type ClusterClusterEndpointArray []ClusterClusterEndpointInput
func (ClusterClusterEndpointArray) ElementType ¶
func (ClusterClusterEndpointArray) ElementType() reflect.Type
func (ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutput ¶
func (i ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutput() ClusterClusterEndpointArrayOutput
func (ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutputWithContext ¶
func (i ClusterClusterEndpointArray) ToClusterClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterClusterEndpointArrayOutput
type ClusterClusterEndpointArrayInput ¶
type ClusterClusterEndpointArrayInput interface { pulumi.Input ToClusterClusterEndpointArrayOutput() ClusterClusterEndpointArrayOutput ToClusterClusterEndpointArrayOutputWithContext(context.Context) ClusterClusterEndpointArrayOutput }
ClusterClusterEndpointArrayInput is an input type that accepts ClusterClusterEndpointArray and ClusterClusterEndpointArrayOutput values. You can construct a concrete instance of `ClusterClusterEndpointArrayInput` via:
ClusterClusterEndpointArray{ ClusterClusterEndpointArgs{...} }
type ClusterClusterEndpointArrayOutput ¶
type ClusterClusterEndpointArrayOutput struct{ *pulumi.OutputState }
func (ClusterClusterEndpointArrayOutput) ElementType ¶
func (ClusterClusterEndpointArrayOutput) ElementType() reflect.Type
func (ClusterClusterEndpointArrayOutput) Index ¶
func (o ClusterClusterEndpointArrayOutput) Index(i pulumi.IntInput) ClusterClusterEndpointOutput
func (ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutput ¶
func (o ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutput() ClusterClusterEndpointArrayOutput
func (ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutputWithContext ¶
func (o ClusterClusterEndpointArrayOutput) ToClusterClusterEndpointArrayOutputWithContext(ctx context.Context) ClusterClusterEndpointArrayOutput
type ClusterClusterEndpointInput ¶
type ClusterClusterEndpointInput interface { pulumi.Input ToClusterClusterEndpointOutput() ClusterClusterEndpointOutput ToClusterClusterEndpointOutputWithContext(context.Context) ClusterClusterEndpointOutput }
ClusterClusterEndpointInput is an input type that accepts ClusterClusterEndpointArgs and ClusterClusterEndpointOutput values. You can construct a concrete instance of `ClusterClusterEndpointInput` via:
ClusterClusterEndpointArgs{...}
type ClusterClusterEndpointOutput ¶
type ClusterClusterEndpointOutput struct{ *pulumi.OutputState }
func (ClusterClusterEndpointOutput) Address ¶
func (o ClusterClusterEndpointOutput) Address() pulumi.StringPtrOutput
DNS hostname of the node.
func (ClusterClusterEndpointOutput) ElementType ¶
func (ClusterClusterEndpointOutput) ElementType() reflect.Type
func (ClusterClusterEndpointOutput) Port ¶
func (o ClusterClusterEndpointOutput) Port() pulumi.IntPtrOutput
The port number on which each of the nodes accepts connections. Defaults to `6379`.
func (ClusterClusterEndpointOutput) ToClusterClusterEndpointOutput ¶
func (o ClusterClusterEndpointOutput) ToClusterClusterEndpointOutput() ClusterClusterEndpointOutput
func (ClusterClusterEndpointOutput) ToClusterClusterEndpointOutputWithContext ¶
func (o ClusterClusterEndpointOutput) ToClusterClusterEndpointOutputWithContext(ctx context.Context) ClusterClusterEndpointOutput
type ClusterInput ¶
type ClusterInput interface { pulumi.Input ToClusterOutput() ClusterOutput ToClusterOutputWithContext(ctx context.Context) ClusterOutput }
type ClusterMap ¶
type ClusterMap map[string]ClusterInput
func (ClusterMap) ElementType ¶
func (ClusterMap) ElementType() reflect.Type
func (ClusterMap) ToClusterMapOutput ¶
func (i ClusterMap) ToClusterMapOutput() ClusterMapOutput
func (ClusterMap) ToClusterMapOutputWithContext ¶
func (i ClusterMap) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput
type ClusterMapInput ¶
type ClusterMapInput interface { pulumi.Input ToClusterMapOutput() ClusterMapOutput ToClusterMapOutputWithContext(context.Context) ClusterMapOutput }
ClusterMapInput is an input type that accepts ClusterMap and ClusterMapOutput values. You can construct a concrete instance of `ClusterMapInput` via:
ClusterMap{ "key": ClusterArgs{...} }
type ClusterMapOutput ¶
type ClusterMapOutput struct{ *pulumi.OutputState }
func (ClusterMapOutput) ElementType ¶
func (ClusterMapOutput) ElementType() reflect.Type
func (ClusterMapOutput) MapIndex ¶
func (o ClusterMapOutput) MapIndex(k pulumi.StringInput) ClusterOutput
func (ClusterMapOutput) ToClusterMapOutput ¶
func (o ClusterMapOutput) ToClusterMapOutput() ClusterMapOutput
func (ClusterMapOutput) ToClusterMapOutputWithContext ¶
func (o ClusterMapOutput) ToClusterMapOutputWithContext(ctx context.Context) ClusterMapOutput
type ClusterOutput ¶
type ClusterOutput struct{ *pulumi.OutputState }
func (ClusterOutput) ElementType ¶
func (ClusterOutput) ElementType() reflect.Type
func (ClusterOutput) ToClusterOutput ¶
func (o ClusterOutput) ToClusterOutput() ClusterOutput
func (ClusterOutput) ToClusterOutputWithContext ¶
func (o ClusterOutput) ToClusterOutputWithContext(ctx context.Context) ClusterOutput
type ClusterShard ¶
type ClusterShard struct { // Name of this node. // * `endpoint` Name *string `pulumi:"name"` // Set of nodes in this shard. Nodes []ClusterShardNode `pulumi:"nodes"` // Number of individual nodes in this shard. NumNodes *int `pulumi:"numNodes"` // Keyspace for this shard. Example: `0-16383`. Slots *string `pulumi:"slots"` }
type ClusterShardArgs ¶
type ClusterShardArgs struct { // Name of this node. // * `endpoint` Name pulumi.StringPtrInput `pulumi:"name"` // Set of nodes in this shard. Nodes ClusterShardNodeArrayInput `pulumi:"nodes"` // Number of individual nodes in this shard. NumNodes pulumi.IntPtrInput `pulumi:"numNodes"` // Keyspace for this shard. Example: `0-16383`. Slots pulumi.StringPtrInput `pulumi:"slots"` }
func (ClusterShardArgs) ElementType ¶
func (ClusterShardArgs) ElementType() reflect.Type
func (ClusterShardArgs) ToClusterShardOutput ¶
func (i ClusterShardArgs) ToClusterShardOutput() ClusterShardOutput
func (ClusterShardArgs) ToClusterShardOutputWithContext ¶
func (i ClusterShardArgs) ToClusterShardOutputWithContext(ctx context.Context) ClusterShardOutput
type ClusterShardArray ¶
type ClusterShardArray []ClusterShardInput
func (ClusterShardArray) ElementType ¶
func (ClusterShardArray) ElementType() reflect.Type
func (ClusterShardArray) ToClusterShardArrayOutput ¶
func (i ClusterShardArray) ToClusterShardArrayOutput() ClusterShardArrayOutput
func (ClusterShardArray) ToClusterShardArrayOutputWithContext ¶
func (i ClusterShardArray) ToClusterShardArrayOutputWithContext(ctx context.Context) ClusterShardArrayOutput
type ClusterShardArrayInput ¶
type ClusterShardArrayInput interface { pulumi.Input ToClusterShardArrayOutput() ClusterShardArrayOutput ToClusterShardArrayOutputWithContext(context.Context) ClusterShardArrayOutput }
ClusterShardArrayInput is an input type that accepts ClusterShardArray and ClusterShardArrayOutput values. You can construct a concrete instance of `ClusterShardArrayInput` via:
ClusterShardArray{ ClusterShardArgs{...} }
type ClusterShardArrayOutput ¶
type ClusterShardArrayOutput struct{ *pulumi.OutputState }
func (ClusterShardArrayOutput) ElementType ¶
func (ClusterShardArrayOutput) ElementType() reflect.Type
func (ClusterShardArrayOutput) Index ¶
func (o ClusterShardArrayOutput) Index(i pulumi.IntInput) ClusterShardOutput
func (ClusterShardArrayOutput) ToClusterShardArrayOutput ¶
func (o ClusterShardArrayOutput) ToClusterShardArrayOutput() ClusterShardArrayOutput
func (ClusterShardArrayOutput) ToClusterShardArrayOutputWithContext ¶
func (o ClusterShardArrayOutput) ToClusterShardArrayOutputWithContext(ctx context.Context) ClusterShardArrayOutput
type ClusterShardInput ¶
type ClusterShardInput interface { pulumi.Input ToClusterShardOutput() ClusterShardOutput ToClusterShardOutputWithContext(context.Context) ClusterShardOutput }
ClusterShardInput is an input type that accepts ClusterShardArgs and ClusterShardOutput values. You can construct a concrete instance of `ClusterShardInput` via:
ClusterShardArgs{...}
type ClusterShardNode ¶
type ClusterShardNode struct { // The Availability Zone in which the node resides. AvailabilityZone *string `pulumi:"availabilityZone"` // The date and time when the node was created. Example: `2022-01-01T21:00:00Z`. CreateTime *string `pulumi:"createTime"` Endpoints []ClusterShardNodeEndpoint `pulumi:"endpoints"` // Name of this node. // * `endpoint` Name *string `pulumi:"name"` }
type ClusterShardNodeArgs ¶
type ClusterShardNodeArgs struct { // The Availability Zone in which the node resides. AvailabilityZone pulumi.StringPtrInput `pulumi:"availabilityZone"` // The date and time when the node was created. Example: `2022-01-01T21:00:00Z`. CreateTime pulumi.StringPtrInput `pulumi:"createTime"` Endpoints ClusterShardNodeEndpointArrayInput `pulumi:"endpoints"` // Name of this node. // * `endpoint` Name pulumi.StringPtrInput `pulumi:"name"` }
func (ClusterShardNodeArgs) ElementType ¶
func (ClusterShardNodeArgs) ElementType() reflect.Type
func (ClusterShardNodeArgs) ToClusterShardNodeOutput ¶
func (i ClusterShardNodeArgs) ToClusterShardNodeOutput() ClusterShardNodeOutput
func (ClusterShardNodeArgs) ToClusterShardNodeOutputWithContext ¶
func (i ClusterShardNodeArgs) ToClusterShardNodeOutputWithContext(ctx context.Context) ClusterShardNodeOutput
type ClusterShardNodeArray ¶
type ClusterShardNodeArray []ClusterShardNodeInput
func (ClusterShardNodeArray) ElementType ¶
func (ClusterShardNodeArray) ElementType() reflect.Type
func (ClusterShardNodeArray) ToClusterShardNodeArrayOutput ¶
func (i ClusterShardNodeArray) ToClusterShardNodeArrayOutput() ClusterShardNodeArrayOutput
func (ClusterShardNodeArray) ToClusterShardNodeArrayOutputWithContext ¶
func (i ClusterShardNodeArray) ToClusterShardNodeArrayOutputWithContext(ctx context.Context) ClusterShardNodeArrayOutput
type ClusterShardNodeArrayInput ¶
type ClusterShardNodeArrayInput interface { pulumi.Input ToClusterShardNodeArrayOutput() ClusterShardNodeArrayOutput ToClusterShardNodeArrayOutputWithContext(context.Context) ClusterShardNodeArrayOutput }
ClusterShardNodeArrayInput is an input type that accepts ClusterShardNodeArray and ClusterShardNodeArrayOutput values. You can construct a concrete instance of `ClusterShardNodeArrayInput` via:
ClusterShardNodeArray{ ClusterShardNodeArgs{...} }
type ClusterShardNodeArrayOutput ¶
type ClusterShardNodeArrayOutput struct{ *pulumi.OutputState }
func (ClusterShardNodeArrayOutput) ElementType ¶
func (ClusterShardNodeArrayOutput) ElementType() reflect.Type
func (ClusterShardNodeArrayOutput) Index ¶
func (o ClusterShardNodeArrayOutput) Index(i pulumi.IntInput) ClusterShardNodeOutput
func (ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutput ¶
func (o ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutput() ClusterShardNodeArrayOutput
func (ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutputWithContext ¶
func (o ClusterShardNodeArrayOutput) ToClusterShardNodeArrayOutputWithContext(ctx context.Context) ClusterShardNodeArrayOutput
type ClusterShardNodeEndpointArgs ¶
type ClusterShardNodeEndpointArgs struct { // DNS hostname of the node. Address pulumi.StringPtrInput `pulumi:"address"` // The port number on which each of the nodes accepts connections. Defaults to `6379`. Port pulumi.IntPtrInput `pulumi:"port"` }
func (ClusterShardNodeEndpointArgs) ElementType ¶
func (ClusterShardNodeEndpointArgs) ElementType() reflect.Type
func (ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutput ¶
func (i ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutput() ClusterShardNodeEndpointOutput
func (ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutputWithContext ¶
func (i ClusterShardNodeEndpointArgs) ToClusterShardNodeEndpointOutputWithContext(ctx context.Context) ClusterShardNodeEndpointOutput
type ClusterShardNodeEndpointArray ¶
type ClusterShardNodeEndpointArray []ClusterShardNodeEndpointInput
func (ClusterShardNodeEndpointArray) ElementType ¶
func (ClusterShardNodeEndpointArray) ElementType() reflect.Type
func (ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutput ¶
func (i ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutput() ClusterShardNodeEndpointArrayOutput
func (ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutputWithContext ¶
func (i ClusterShardNodeEndpointArray) ToClusterShardNodeEndpointArrayOutputWithContext(ctx context.Context) ClusterShardNodeEndpointArrayOutput
type ClusterShardNodeEndpointArrayInput ¶
type ClusterShardNodeEndpointArrayInput interface { pulumi.Input ToClusterShardNodeEndpointArrayOutput() ClusterShardNodeEndpointArrayOutput ToClusterShardNodeEndpointArrayOutputWithContext(context.Context) ClusterShardNodeEndpointArrayOutput }
ClusterShardNodeEndpointArrayInput is an input type that accepts ClusterShardNodeEndpointArray and ClusterShardNodeEndpointArrayOutput values. You can construct a concrete instance of `ClusterShardNodeEndpointArrayInput` via:
ClusterShardNodeEndpointArray{ ClusterShardNodeEndpointArgs{...} }
type ClusterShardNodeEndpointArrayOutput ¶
type ClusterShardNodeEndpointArrayOutput struct{ *pulumi.OutputState }
func (ClusterShardNodeEndpointArrayOutput) ElementType ¶
func (ClusterShardNodeEndpointArrayOutput) ElementType() reflect.Type
func (ClusterShardNodeEndpointArrayOutput) Index ¶
func (o ClusterShardNodeEndpointArrayOutput) Index(i pulumi.IntInput) ClusterShardNodeEndpointOutput
func (ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutput ¶
func (o ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutput() ClusterShardNodeEndpointArrayOutput
func (ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutputWithContext ¶
func (o ClusterShardNodeEndpointArrayOutput) ToClusterShardNodeEndpointArrayOutputWithContext(ctx context.Context) ClusterShardNodeEndpointArrayOutput
type ClusterShardNodeEndpointInput ¶
type ClusterShardNodeEndpointInput interface { pulumi.Input ToClusterShardNodeEndpointOutput() ClusterShardNodeEndpointOutput ToClusterShardNodeEndpointOutputWithContext(context.Context) ClusterShardNodeEndpointOutput }
ClusterShardNodeEndpointInput is an input type that accepts ClusterShardNodeEndpointArgs and ClusterShardNodeEndpointOutput values. You can construct a concrete instance of `ClusterShardNodeEndpointInput` via:
ClusterShardNodeEndpointArgs{...}
type ClusterShardNodeEndpointOutput ¶
type ClusterShardNodeEndpointOutput struct{ *pulumi.OutputState }
func (ClusterShardNodeEndpointOutput) Address ¶
func (o ClusterShardNodeEndpointOutput) Address() pulumi.StringPtrOutput
DNS hostname of the node.
func (ClusterShardNodeEndpointOutput) ElementType ¶
func (ClusterShardNodeEndpointOutput) ElementType() reflect.Type
func (ClusterShardNodeEndpointOutput) Port ¶
func (o ClusterShardNodeEndpointOutput) Port() pulumi.IntPtrOutput
The port number on which each of the nodes accepts connections. Defaults to `6379`.
func (ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutput ¶
func (o ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutput() ClusterShardNodeEndpointOutput
func (ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutputWithContext ¶
func (o ClusterShardNodeEndpointOutput) ToClusterShardNodeEndpointOutputWithContext(ctx context.Context) ClusterShardNodeEndpointOutput
type ClusterShardNodeInput ¶
type ClusterShardNodeInput interface { pulumi.Input ToClusterShardNodeOutput() ClusterShardNodeOutput ToClusterShardNodeOutputWithContext(context.Context) ClusterShardNodeOutput }
ClusterShardNodeInput is an input type that accepts ClusterShardNodeArgs and ClusterShardNodeOutput values. You can construct a concrete instance of `ClusterShardNodeInput` via:
ClusterShardNodeArgs{...}
type ClusterShardNodeOutput ¶
type ClusterShardNodeOutput struct{ *pulumi.OutputState }
func (ClusterShardNodeOutput) AvailabilityZone ¶
func (o ClusterShardNodeOutput) AvailabilityZone() pulumi.StringPtrOutput
The Availability Zone in which the node resides.
func (ClusterShardNodeOutput) CreateTime ¶
func (o ClusterShardNodeOutput) CreateTime() pulumi.StringPtrOutput
The date and time when the node was created. Example: `2022-01-01T21:00:00Z`.
func (ClusterShardNodeOutput) ElementType ¶
func (ClusterShardNodeOutput) ElementType() reflect.Type
func (ClusterShardNodeOutput) Endpoints ¶
func (o ClusterShardNodeOutput) Endpoints() ClusterShardNodeEndpointArrayOutput
func (ClusterShardNodeOutput) Name ¶
func (o ClusterShardNodeOutput) Name() pulumi.StringPtrOutput
Name of this node. * `endpoint`
func (ClusterShardNodeOutput) ToClusterShardNodeOutput ¶
func (o ClusterShardNodeOutput) ToClusterShardNodeOutput() ClusterShardNodeOutput
func (ClusterShardNodeOutput) ToClusterShardNodeOutputWithContext ¶
func (o ClusterShardNodeOutput) ToClusterShardNodeOutputWithContext(ctx context.Context) ClusterShardNodeOutput
type ClusterShardOutput ¶
type ClusterShardOutput struct{ *pulumi.OutputState }
func (ClusterShardOutput) ElementType ¶
func (ClusterShardOutput) ElementType() reflect.Type
func (ClusterShardOutput) Name ¶
func (o ClusterShardOutput) Name() pulumi.StringPtrOutput
Name of this node. * `endpoint`
func (ClusterShardOutput) Nodes ¶
func (o ClusterShardOutput) Nodes() ClusterShardNodeArrayOutput
Set of nodes in this shard.
func (ClusterShardOutput) NumNodes ¶
func (o ClusterShardOutput) NumNodes() pulumi.IntPtrOutput
Number of individual nodes in this shard.
func (ClusterShardOutput) Slots ¶
func (o ClusterShardOutput) Slots() pulumi.StringPtrOutput
Keyspace for this shard. Example: `0-16383`.
func (ClusterShardOutput) ToClusterShardOutput ¶
func (o ClusterShardOutput) ToClusterShardOutput() ClusterShardOutput
func (ClusterShardOutput) ToClusterShardOutputWithContext ¶
func (o ClusterShardOutput) ToClusterShardOutputWithContext(ctx context.Context) ClusterShardOutput
type ClusterState ¶
type ClusterState struct { // The name of the Access Control List to associate with the cluster. AclName pulumi.StringPtrInput // The ARN of the cluster. // * `clusterEndpoint` Arn pulumi.StringPtrInput // When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`. AutoMinorVersionUpgrade pulumi.BoolPtrInput ClusterEndpoints ClusterClusterEndpointArrayInput Description pulumi.StringPtrInput // Patch version number of the Redis engine used by the cluster. EnginePatchVersion pulumi.StringPtrInput // Version number of the Redis engine to be used for the cluster. Downgrades are not supported. EngineVersion pulumi.StringPtrInput // Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made. FinalSnapshotName pulumi.StringPtrInput // ARN of the KMS key used to encrypt the cluster at rest. KmsKeyArn pulumi.StringPtrInput // Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:23:00-mon:01:30`. MaintenanceWindow pulumi.StringPtrInput // Name of this node. // * `endpoint` Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // The compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.html). NodeType pulumi.StringPtrInput // The number of replicas to apply to each shard, up to a maximum of 5. Defaults to `1` (i.e. 2 nodes per shard). NumReplicasPerShard pulumi.IntPtrInput // The number of shards in the cluster. Defaults to `1`. NumShards pulumi.IntPtrInput // The name of the parameter group associated with the cluster. ParameterGroupName pulumi.StringPtrInput // The port number on which each of the nodes accepts connections. Defaults to `6379`. Port pulumi.IntPtrInput // Set of VPC Security Group ID-s to associate with this cluster. SecurityGroupIds pulumi.StringArrayInput // Set of shards in this cluster. Shards ClusterShardArrayInput // List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s cannot contain any commas. SnapshotArns pulumi.StringPtrInput // The name of a snapshot from which to restore data into the new cluster. SnapshotName pulumi.StringPtrInput // The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to `0`, automatic backups are disabled. Defaults to `0`. SnapshotRetentionLimit pulumi.IntPtrInput // The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: `05:00-09:00`. SnapshotWindow pulumi.StringPtrInput // ARN of the SNS topic to which cluster notifications are sent. SnsTopicArn pulumi.StringPtrInput // The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets. SubnetGroupName pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // A flag to enable in-transit encryption on the cluster. When set to `false`, the `aclName` must be `open-access`. Defaults to `true`. TlsEnabled pulumi.BoolPtrInput }
func (ClusterState) ElementType ¶
func (ClusterState) ElementType() reflect.Type
type ParameterGroup ¶
type ParameterGroup struct { pulumi.CustomResourceState // The ARN of the parameter group. Arn pulumi.StringOutput `pulumi:"arn"` Description pulumi.StringPtrOutput `pulumi:"description"` // The engine version that the parameter group can be used with. Family pulumi.StringOutput `pulumi:"family"` // The name of the parameter. Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below. Parameters ParameterGroupParameterArrayOutput `pulumi:"parameters"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides a MemoryDB Parameter Group.
More information about parameter groups can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/memorydb" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := memorydb.NewParameterGroup(ctx, "example", &memorydb.ParameterGroupArgs{ Family: pulumi.String("memorydb_redis6"), Parameters: memorydb.ParameterGroupParameterArray{ &memorydb.ParameterGroupParameterArgs{ Name: pulumi.String("activedefrag"), Value: pulumi.String("yes"), }, }, }) if err != nil { return err } return nil }) }
```
## Import
Use the `name` to import a parameter group. For example
```sh
$ pulumi import aws:memorydb/parameterGroup:ParameterGroup example my-parameter-group
```
func GetParameterGroup ¶
func GetParameterGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ParameterGroupState, opts ...pulumi.ResourceOption) (*ParameterGroup, error)
GetParameterGroup gets an existing ParameterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewParameterGroup ¶
func NewParameterGroup(ctx *pulumi.Context, name string, args *ParameterGroupArgs, opts ...pulumi.ResourceOption) (*ParameterGroup, error)
NewParameterGroup registers a new resource with the given unique name, arguments, and options.
func (*ParameterGroup) ElementType ¶
func (*ParameterGroup) ElementType() reflect.Type
func (*ParameterGroup) ToParameterGroupOutput ¶
func (i *ParameterGroup) ToParameterGroupOutput() ParameterGroupOutput
func (*ParameterGroup) ToParameterGroupOutputWithContext ¶
func (i *ParameterGroup) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput
type ParameterGroupArgs ¶
type ParameterGroupArgs struct { Description pulumi.StringPtrInput // The engine version that the parameter group can be used with. Family pulumi.StringInput // The name of the parameter. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput }
The set of arguments for constructing a ParameterGroup resource.
func (ParameterGroupArgs) ElementType ¶
func (ParameterGroupArgs) ElementType() reflect.Type
type ParameterGroupArray ¶
type ParameterGroupArray []ParameterGroupInput
func (ParameterGroupArray) ElementType ¶
func (ParameterGroupArray) ElementType() reflect.Type
func (ParameterGroupArray) ToParameterGroupArrayOutput ¶
func (i ParameterGroupArray) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
func (ParameterGroupArray) ToParameterGroupArrayOutputWithContext ¶
func (i ParameterGroupArray) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
type ParameterGroupArrayInput ¶
type ParameterGroupArrayInput interface { pulumi.Input ToParameterGroupArrayOutput() ParameterGroupArrayOutput ToParameterGroupArrayOutputWithContext(context.Context) ParameterGroupArrayOutput }
ParameterGroupArrayInput is an input type that accepts ParameterGroupArray and ParameterGroupArrayOutput values. You can construct a concrete instance of `ParameterGroupArrayInput` via:
ParameterGroupArray{ ParameterGroupArgs{...} }
type ParameterGroupArrayOutput ¶
type ParameterGroupArrayOutput struct{ *pulumi.OutputState }
func (ParameterGroupArrayOutput) ElementType ¶
func (ParameterGroupArrayOutput) ElementType() reflect.Type
func (ParameterGroupArrayOutput) Index ¶
func (o ParameterGroupArrayOutput) Index(i pulumi.IntInput) ParameterGroupOutput
func (ParameterGroupArrayOutput) ToParameterGroupArrayOutput ¶
func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutput() ParameterGroupArrayOutput
func (ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext ¶
func (o ParameterGroupArrayOutput) ToParameterGroupArrayOutputWithContext(ctx context.Context) ParameterGroupArrayOutput
type ParameterGroupInput ¶
type ParameterGroupInput interface { pulumi.Input ToParameterGroupOutput() ParameterGroupOutput ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput }
type ParameterGroupMap ¶
type ParameterGroupMap map[string]ParameterGroupInput
func (ParameterGroupMap) ElementType ¶
func (ParameterGroupMap) ElementType() reflect.Type
func (ParameterGroupMap) ToParameterGroupMapOutput ¶
func (i ParameterGroupMap) ToParameterGroupMapOutput() ParameterGroupMapOutput
func (ParameterGroupMap) ToParameterGroupMapOutputWithContext ¶
func (i ParameterGroupMap) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
type ParameterGroupMapInput ¶
type ParameterGroupMapInput interface { pulumi.Input ToParameterGroupMapOutput() ParameterGroupMapOutput ToParameterGroupMapOutputWithContext(context.Context) ParameterGroupMapOutput }
ParameterGroupMapInput is an input type that accepts ParameterGroupMap and ParameterGroupMapOutput values. You can construct a concrete instance of `ParameterGroupMapInput` via:
ParameterGroupMap{ "key": ParameterGroupArgs{...} }
type ParameterGroupMapOutput ¶
type ParameterGroupMapOutput struct{ *pulumi.OutputState }
func (ParameterGroupMapOutput) ElementType ¶
func (ParameterGroupMapOutput) ElementType() reflect.Type
func (ParameterGroupMapOutput) MapIndex ¶
func (o ParameterGroupMapOutput) MapIndex(k pulumi.StringInput) ParameterGroupOutput
func (ParameterGroupMapOutput) ToParameterGroupMapOutput ¶
func (o ParameterGroupMapOutput) ToParameterGroupMapOutput() ParameterGroupMapOutput
func (ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext ¶
func (o ParameterGroupMapOutput) ToParameterGroupMapOutputWithContext(ctx context.Context) ParameterGroupMapOutput
type ParameterGroupOutput ¶
type ParameterGroupOutput struct{ *pulumi.OutputState }
func (ParameterGroupOutput) ElementType ¶
func (ParameterGroupOutput) ElementType() reflect.Type
func (ParameterGroupOutput) ToParameterGroupOutput ¶
func (o ParameterGroupOutput) ToParameterGroupOutput() ParameterGroupOutput
func (ParameterGroupOutput) ToParameterGroupOutputWithContext ¶
func (o ParameterGroupOutput) ToParameterGroupOutputWithContext(ctx context.Context) ParameterGroupOutput
type ParameterGroupParameter ¶
type ParameterGroupParameterArgs ¶
type ParameterGroupParameterArgs struct { // The name of the parameter. Name pulumi.StringInput `pulumi:"name"` // The value of the parameter. Value pulumi.StringInput `pulumi:"value"` }
func (ParameterGroupParameterArgs) ElementType ¶
func (ParameterGroupParameterArgs) ElementType() reflect.Type
func (ParameterGroupParameterArgs) ToParameterGroupParameterOutput ¶
func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutput() ParameterGroupParameterOutput
func (ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext ¶
func (i ParameterGroupParameterArgs) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput
type ParameterGroupParameterArray ¶
type ParameterGroupParameterArray []ParameterGroupParameterInput
func (ParameterGroupParameterArray) ElementType ¶
func (ParameterGroupParameterArray) ElementType() reflect.Type
func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput ¶
func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
func (ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext ¶
func (i ParameterGroupParameterArray) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
type ParameterGroupParameterArrayInput ¶
type ParameterGroupParameterArrayInput interface { pulumi.Input ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput ToParameterGroupParameterArrayOutputWithContext(context.Context) ParameterGroupParameterArrayOutput }
ParameterGroupParameterArrayInput is an input type that accepts ParameterGroupParameterArray and ParameterGroupParameterArrayOutput values. You can construct a concrete instance of `ParameterGroupParameterArrayInput` via:
ParameterGroupParameterArray{ ParameterGroupParameterArgs{...} }
type ParameterGroupParameterArrayOutput ¶
type ParameterGroupParameterArrayOutput struct{ *pulumi.OutputState }
func (ParameterGroupParameterArrayOutput) ElementType ¶
func (ParameterGroupParameterArrayOutput) ElementType() reflect.Type
func (ParameterGroupParameterArrayOutput) Index ¶
func (o ParameterGroupParameterArrayOutput) Index(i pulumi.IntInput) ParameterGroupParameterOutput
func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput ¶
func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutput() ParameterGroupParameterArrayOutput
func (ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext ¶
func (o ParameterGroupParameterArrayOutput) ToParameterGroupParameterArrayOutputWithContext(ctx context.Context) ParameterGroupParameterArrayOutput
type ParameterGroupParameterInput ¶
type ParameterGroupParameterInput interface { pulumi.Input ToParameterGroupParameterOutput() ParameterGroupParameterOutput ToParameterGroupParameterOutputWithContext(context.Context) ParameterGroupParameterOutput }
ParameterGroupParameterInput is an input type that accepts ParameterGroupParameterArgs and ParameterGroupParameterOutput values. You can construct a concrete instance of `ParameterGroupParameterInput` via:
ParameterGroupParameterArgs{...}
type ParameterGroupParameterOutput ¶
type ParameterGroupParameterOutput struct{ *pulumi.OutputState }
func (ParameterGroupParameterOutput) ElementType ¶
func (ParameterGroupParameterOutput) ElementType() reflect.Type
func (ParameterGroupParameterOutput) Name ¶
func (o ParameterGroupParameterOutput) Name() pulumi.StringOutput
The name of the parameter.
func (ParameterGroupParameterOutput) ToParameterGroupParameterOutput ¶
func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutput() ParameterGroupParameterOutput
func (ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext ¶
func (o ParameterGroupParameterOutput) ToParameterGroupParameterOutputWithContext(ctx context.Context) ParameterGroupParameterOutput
func (ParameterGroupParameterOutput) Value ¶
func (o ParameterGroupParameterOutput) Value() pulumi.StringOutput
The value of the parameter.
type ParameterGroupState ¶
type ParameterGroupState struct { // The ARN of the parameter group. Arn pulumi.StringPtrInput Description pulumi.StringPtrInput // The engine version that the parameter group can be used with. Family pulumi.StringPtrInput // The name of the parameter. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // Set of MemoryDB parameters to apply. Any parameters not specified will fall back to their family defaults. Detailed below. Parameters ParameterGroupParameterArrayInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput }
func (ParameterGroupState) ElementType ¶
func (ParameterGroupState) ElementType() reflect.Type
type Snapshot ¶ added in v4.35.0
type Snapshot struct { pulumi.CustomResourceState // The ARN of the snapshot. Arn pulumi.StringOutput `pulumi:"arn"` // The configuration of the cluster from which the snapshot was taken. ClusterConfigurations SnapshotClusterConfigurationArrayOutput `pulumi:"clusterConfigurations"` // Name of the MemoryDB cluster to take a snapshot of. ClusterName pulumi.StringOutput `pulumi:"clusterName"` // ARN of the KMS key used to encrypt the snapshot at rest. KmsKeyArn pulumi.StringPtrOutput `pulumi:"kmsKeyArn"` // Name of the cluster. Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`). Source pulumi.StringOutput `pulumi:"source"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` }
Provides a MemoryDB Snapshot.
More information about snapshot and restore can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots.html).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/memorydb" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := memorydb.NewSnapshot(ctx, "example", &memorydb.SnapshotArgs{ ClusterName: pulumi.Any(aws_memorydb_cluster.Example.Name), }) if err != nil { return err } return nil }) }
```
## Import
Use the `name` to import a snapshot. For example
```sh
$ pulumi import aws:memorydb/snapshot:Snapshot example my-snapshot
```
func GetSnapshot ¶ added in v4.35.0
func GetSnapshot(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SnapshotState, opts ...pulumi.ResourceOption) (*Snapshot, error)
GetSnapshot gets an existing Snapshot resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSnapshot ¶ added in v4.35.0
func NewSnapshot(ctx *pulumi.Context, name string, args *SnapshotArgs, opts ...pulumi.ResourceOption) (*Snapshot, error)
NewSnapshot registers a new resource with the given unique name, arguments, and options.
func (*Snapshot) ElementType ¶ added in v4.35.0
func (*Snapshot) ToSnapshotOutput ¶ added in v4.35.0
func (i *Snapshot) ToSnapshotOutput() SnapshotOutput
func (*Snapshot) ToSnapshotOutputWithContext ¶ added in v4.35.0
func (i *Snapshot) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
type SnapshotArgs ¶ added in v4.35.0
type SnapshotArgs struct { // Name of the MemoryDB cluster to take a snapshot of. ClusterName pulumi.StringInput // ARN of the KMS key used to encrypt the snapshot at rest. KmsKeyArn pulumi.StringPtrInput // Name of the cluster. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput }
The set of arguments for constructing a Snapshot resource.
func (SnapshotArgs) ElementType ¶ added in v4.35.0
func (SnapshotArgs) ElementType() reflect.Type
type SnapshotArray ¶ added in v4.35.0
type SnapshotArray []SnapshotInput
func (SnapshotArray) ElementType ¶ added in v4.35.0
func (SnapshotArray) ElementType() reflect.Type
func (SnapshotArray) ToSnapshotArrayOutput ¶ added in v4.35.0
func (i SnapshotArray) ToSnapshotArrayOutput() SnapshotArrayOutput
func (SnapshotArray) ToSnapshotArrayOutputWithContext ¶ added in v4.35.0
func (i SnapshotArray) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput
type SnapshotArrayInput ¶ added in v4.35.0
type SnapshotArrayInput interface { pulumi.Input ToSnapshotArrayOutput() SnapshotArrayOutput ToSnapshotArrayOutputWithContext(context.Context) SnapshotArrayOutput }
SnapshotArrayInput is an input type that accepts SnapshotArray and SnapshotArrayOutput values. You can construct a concrete instance of `SnapshotArrayInput` via:
SnapshotArray{ SnapshotArgs{...} }
type SnapshotArrayOutput ¶ added in v4.35.0
type SnapshotArrayOutput struct{ *pulumi.OutputState }
func (SnapshotArrayOutput) ElementType ¶ added in v4.35.0
func (SnapshotArrayOutput) ElementType() reflect.Type
func (SnapshotArrayOutput) Index ¶ added in v4.35.0
func (o SnapshotArrayOutput) Index(i pulumi.IntInput) SnapshotOutput
func (SnapshotArrayOutput) ToSnapshotArrayOutput ¶ added in v4.35.0
func (o SnapshotArrayOutput) ToSnapshotArrayOutput() SnapshotArrayOutput
func (SnapshotArrayOutput) ToSnapshotArrayOutputWithContext ¶ added in v4.35.0
func (o SnapshotArrayOutput) ToSnapshotArrayOutputWithContext(ctx context.Context) SnapshotArrayOutput
type SnapshotClusterConfiguration ¶ added in v4.35.0
type SnapshotClusterConfiguration struct { // Description for the cluster. Description *string `pulumi:"description"` // Version number of the Redis engine used by the cluster. EngineVersion *string `pulumi:"engineVersion"` // The weekly time range during which maintenance on the cluster is performed. MaintenanceWindow *string `pulumi:"maintenanceWindow"` // Name of the cluster. Name *string `pulumi:"name"` // Compute and memory capacity of the nodes in the cluster. NodeType *string `pulumi:"nodeType"` // Number of shards in the cluster. NumShards *int `pulumi:"numShards"` // Name of the parameter group associated with the cluster. ParameterGroupName *string `pulumi:"parameterGroupName"` // Port number on which the cluster accepts connections. Port *int `pulumi:"port"` // Number of days for which MemoryDB retains automatic snapshots before deleting them. SnapshotRetentionLimit *int `pulumi:"snapshotRetentionLimit"` // The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard. SnapshotWindow *string `pulumi:"snapshotWindow"` // Name of the subnet group used by the cluster. SubnetGroupName *string `pulumi:"subnetGroupName"` // ARN of the SNS topic to which cluster notifications are sent. TopicArn *string `pulumi:"topicArn"` // The VPC in which the cluster exists. VpcId *string `pulumi:"vpcId"` }
type SnapshotClusterConfigurationArgs ¶ added in v4.35.0
type SnapshotClusterConfigurationArgs struct { // Description for the cluster. Description pulumi.StringPtrInput `pulumi:"description"` // Version number of the Redis engine used by the cluster. EngineVersion pulumi.StringPtrInput `pulumi:"engineVersion"` // The weekly time range during which maintenance on the cluster is performed. MaintenanceWindow pulumi.StringPtrInput `pulumi:"maintenanceWindow"` // Name of the cluster. Name pulumi.StringPtrInput `pulumi:"name"` // Compute and memory capacity of the nodes in the cluster. NodeType pulumi.StringPtrInput `pulumi:"nodeType"` // Number of shards in the cluster. NumShards pulumi.IntPtrInput `pulumi:"numShards"` // Name of the parameter group associated with the cluster. ParameterGroupName pulumi.StringPtrInput `pulumi:"parameterGroupName"` // Port number on which the cluster accepts connections. Port pulumi.IntPtrInput `pulumi:"port"` // Number of days for which MemoryDB retains automatic snapshots before deleting them. SnapshotRetentionLimit pulumi.IntPtrInput `pulumi:"snapshotRetentionLimit"` // The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard. SnapshotWindow pulumi.StringPtrInput `pulumi:"snapshotWindow"` // Name of the subnet group used by the cluster. SubnetGroupName pulumi.StringPtrInput `pulumi:"subnetGroupName"` // ARN of the SNS topic to which cluster notifications are sent. TopicArn pulumi.StringPtrInput `pulumi:"topicArn"` // The VPC in which the cluster exists. VpcId pulumi.StringPtrInput `pulumi:"vpcId"` }
func (SnapshotClusterConfigurationArgs) ElementType ¶ added in v4.35.0
func (SnapshotClusterConfigurationArgs) ElementType() reflect.Type
func (SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutput ¶ added in v4.35.0
func (i SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutput() SnapshotClusterConfigurationOutput
func (SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutputWithContext ¶ added in v4.35.0
func (i SnapshotClusterConfigurationArgs) ToSnapshotClusterConfigurationOutputWithContext(ctx context.Context) SnapshotClusterConfigurationOutput
type SnapshotClusterConfigurationArray ¶ added in v4.35.0
type SnapshotClusterConfigurationArray []SnapshotClusterConfigurationInput
func (SnapshotClusterConfigurationArray) ElementType ¶ added in v4.35.0
func (SnapshotClusterConfigurationArray) ElementType() reflect.Type
func (SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutput ¶ added in v4.35.0
func (i SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutput() SnapshotClusterConfigurationArrayOutput
func (SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutputWithContext ¶ added in v4.35.0
func (i SnapshotClusterConfigurationArray) ToSnapshotClusterConfigurationArrayOutputWithContext(ctx context.Context) SnapshotClusterConfigurationArrayOutput
type SnapshotClusterConfigurationArrayInput ¶ added in v4.35.0
type SnapshotClusterConfigurationArrayInput interface { pulumi.Input ToSnapshotClusterConfigurationArrayOutput() SnapshotClusterConfigurationArrayOutput ToSnapshotClusterConfigurationArrayOutputWithContext(context.Context) SnapshotClusterConfigurationArrayOutput }
SnapshotClusterConfigurationArrayInput is an input type that accepts SnapshotClusterConfigurationArray and SnapshotClusterConfigurationArrayOutput values. You can construct a concrete instance of `SnapshotClusterConfigurationArrayInput` via:
SnapshotClusterConfigurationArray{ SnapshotClusterConfigurationArgs{...} }
type SnapshotClusterConfigurationArrayOutput ¶ added in v4.35.0
type SnapshotClusterConfigurationArrayOutput struct{ *pulumi.OutputState }
func (SnapshotClusterConfigurationArrayOutput) ElementType ¶ added in v4.35.0
func (SnapshotClusterConfigurationArrayOutput) ElementType() reflect.Type
func (SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutput ¶ added in v4.35.0
func (o SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutput() SnapshotClusterConfigurationArrayOutput
func (SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutputWithContext ¶ added in v4.35.0
func (o SnapshotClusterConfigurationArrayOutput) ToSnapshotClusterConfigurationArrayOutputWithContext(ctx context.Context) SnapshotClusterConfigurationArrayOutput
type SnapshotClusterConfigurationInput ¶ added in v4.35.0
type SnapshotClusterConfigurationInput interface { pulumi.Input ToSnapshotClusterConfigurationOutput() SnapshotClusterConfigurationOutput ToSnapshotClusterConfigurationOutputWithContext(context.Context) SnapshotClusterConfigurationOutput }
SnapshotClusterConfigurationInput is an input type that accepts SnapshotClusterConfigurationArgs and SnapshotClusterConfigurationOutput values. You can construct a concrete instance of `SnapshotClusterConfigurationInput` via:
SnapshotClusterConfigurationArgs{...}
type SnapshotClusterConfigurationOutput ¶ added in v4.35.0
type SnapshotClusterConfigurationOutput struct{ *pulumi.OutputState }
func (SnapshotClusterConfigurationOutput) Description ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) Description() pulumi.StringPtrOutput
Description for the cluster.
func (SnapshotClusterConfigurationOutput) ElementType ¶ added in v4.35.0
func (SnapshotClusterConfigurationOutput) ElementType() reflect.Type
func (SnapshotClusterConfigurationOutput) EngineVersion ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) EngineVersion() pulumi.StringPtrOutput
Version number of the Redis engine used by the cluster.
func (SnapshotClusterConfigurationOutput) MaintenanceWindow ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) MaintenanceWindow() pulumi.StringPtrOutput
The weekly time range during which maintenance on the cluster is performed.
func (SnapshotClusterConfigurationOutput) Name ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) Name() pulumi.StringPtrOutput
Name of the cluster.
func (SnapshotClusterConfigurationOutput) NodeType ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) NodeType() pulumi.StringPtrOutput
Compute and memory capacity of the nodes in the cluster.
func (SnapshotClusterConfigurationOutput) NumShards ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) NumShards() pulumi.IntPtrOutput
Number of shards in the cluster.
func (SnapshotClusterConfigurationOutput) ParameterGroupName ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) ParameterGroupName() pulumi.StringPtrOutput
Name of the parameter group associated with the cluster.
func (SnapshotClusterConfigurationOutput) Port ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) Port() pulumi.IntPtrOutput
Port number on which the cluster accepts connections.
func (SnapshotClusterConfigurationOutput) SnapshotRetentionLimit ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) SnapshotRetentionLimit() pulumi.IntPtrOutput
Number of days for which MemoryDB retains automatic snapshots before deleting them.
func (SnapshotClusterConfigurationOutput) SnapshotWindow ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) SnapshotWindow() pulumi.StringPtrOutput
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
func (SnapshotClusterConfigurationOutput) SubnetGroupName ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) SubnetGroupName() pulumi.StringPtrOutput
Name of the subnet group used by the cluster.
func (SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutput ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutput() SnapshotClusterConfigurationOutput
func (SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutputWithContext ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) ToSnapshotClusterConfigurationOutputWithContext(ctx context.Context) SnapshotClusterConfigurationOutput
func (SnapshotClusterConfigurationOutput) TopicArn ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) TopicArn() pulumi.StringPtrOutput
ARN of the SNS topic to which cluster notifications are sent.
func (SnapshotClusterConfigurationOutput) VpcId ¶ added in v4.35.0
func (o SnapshotClusterConfigurationOutput) VpcId() pulumi.StringPtrOutput
The VPC in which the cluster exists.
type SnapshotInput ¶ added in v4.35.0
type SnapshotInput interface { pulumi.Input ToSnapshotOutput() SnapshotOutput ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput }
type SnapshotMap ¶ added in v4.35.0
type SnapshotMap map[string]SnapshotInput
func (SnapshotMap) ElementType ¶ added in v4.35.0
func (SnapshotMap) ElementType() reflect.Type
func (SnapshotMap) ToSnapshotMapOutput ¶ added in v4.35.0
func (i SnapshotMap) ToSnapshotMapOutput() SnapshotMapOutput
func (SnapshotMap) ToSnapshotMapOutputWithContext ¶ added in v4.35.0
func (i SnapshotMap) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput
type SnapshotMapInput ¶ added in v4.35.0
type SnapshotMapInput interface { pulumi.Input ToSnapshotMapOutput() SnapshotMapOutput ToSnapshotMapOutputWithContext(context.Context) SnapshotMapOutput }
SnapshotMapInput is an input type that accepts SnapshotMap and SnapshotMapOutput values. You can construct a concrete instance of `SnapshotMapInput` via:
SnapshotMap{ "key": SnapshotArgs{...} }
type SnapshotMapOutput ¶ added in v4.35.0
type SnapshotMapOutput struct{ *pulumi.OutputState }
func (SnapshotMapOutput) ElementType ¶ added in v4.35.0
func (SnapshotMapOutput) ElementType() reflect.Type
func (SnapshotMapOutput) MapIndex ¶ added in v4.35.0
func (o SnapshotMapOutput) MapIndex(k pulumi.StringInput) SnapshotOutput
func (SnapshotMapOutput) ToSnapshotMapOutput ¶ added in v4.35.0
func (o SnapshotMapOutput) ToSnapshotMapOutput() SnapshotMapOutput
func (SnapshotMapOutput) ToSnapshotMapOutputWithContext ¶ added in v4.35.0
func (o SnapshotMapOutput) ToSnapshotMapOutputWithContext(ctx context.Context) SnapshotMapOutput
type SnapshotOutput ¶ added in v4.35.0
type SnapshotOutput struct{ *pulumi.OutputState }
func (SnapshotOutput) ElementType ¶ added in v4.35.0
func (SnapshotOutput) ElementType() reflect.Type
func (SnapshotOutput) ToSnapshotOutput ¶ added in v4.35.0
func (o SnapshotOutput) ToSnapshotOutput() SnapshotOutput
func (SnapshotOutput) ToSnapshotOutputWithContext ¶ added in v4.35.0
func (o SnapshotOutput) ToSnapshotOutputWithContext(ctx context.Context) SnapshotOutput
type SnapshotState ¶ added in v4.35.0
type SnapshotState struct { // The ARN of the snapshot. Arn pulumi.StringPtrInput // The configuration of the cluster from which the snapshot was taken. ClusterConfigurations SnapshotClusterConfigurationArrayInput // Name of the MemoryDB cluster to take a snapshot of. ClusterName pulumi.StringPtrInput // ARN of the KMS key used to encrypt the snapshot at rest. KmsKeyArn pulumi.StringPtrInput // Name of the cluster. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // Indicates whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`). Source pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput }
func (SnapshotState) ElementType ¶ added in v4.35.0
func (SnapshotState) ElementType() reflect.Type
type SubnetGroup ¶
type SubnetGroup struct { pulumi.CustomResourceState // The ARN of the subnet group. Arn pulumi.StringOutput `pulumi:"arn"` Description pulumi.StringPtrOutput `pulumi:"description"` Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided. SubnetIds pulumi.StringArrayOutput `pulumi:"subnetIds"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // The VPC in which the subnet group exists. VpcId pulumi.StringOutput `pulumi:"vpcId"` }
Provides a MemoryDB Subnet Group.
More information about subnet groups can be found in the [MemoryDB User Guide](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html).
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2" "github.com/pulumi/pulumi-aws/sdk/v4/go/aws/memorydb" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { exampleVpc, err := ec2.NewVpc(ctx, "exampleVpc", &ec2.VpcArgs{ CidrBlock: pulumi.String("10.0.0.0/16"), }) if err != nil { return err } exampleSubnet, err := ec2.NewSubnet(ctx, "exampleSubnet", &ec2.SubnetArgs{ VpcId: exampleVpc.ID(), CidrBlock: pulumi.String("10.0.0.0/24"), AvailabilityZone: pulumi.String("us-west-2a"), }) if err != nil { return err } _, err = memorydb.NewSubnetGroup(ctx, "exampleSubnetGroup", &memorydb.SubnetGroupArgs{ SubnetIds: pulumi.StringArray{ exampleSubnet.ID(), }, }) if err != nil { return err } return nil }) }
```
## Import
Use the `name` to import a subnet group. For example
```sh
$ pulumi import aws:memorydb/subnetGroup:SubnetGroup example my-subnet-group
```
func GetSubnetGroup ¶
func GetSubnetGroup(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SubnetGroupState, opts ...pulumi.ResourceOption) (*SubnetGroup, error)
GetSubnetGroup gets an existing SubnetGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSubnetGroup ¶
func NewSubnetGroup(ctx *pulumi.Context, name string, args *SubnetGroupArgs, opts ...pulumi.ResourceOption) (*SubnetGroup, error)
NewSubnetGroup registers a new resource with the given unique name, arguments, and options.
func (*SubnetGroup) ElementType ¶
func (*SubnetGroup) ElementType() reflect.Type
func (*SubnetGroup) ToSubnetGroupOutput ¶
func (i *SubnetGroup) ToSubnetGroupOutput() SubnetGroupOutput
func (*SubnetGroup) ToSubnetGroupOutputWithContext ¶
func (i *SubnetGroup) ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput
type SubnetGroupArgs ¶
type SubnetGroupArgs struct { Description pulumi.StringPtrInput Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided. SubnetIds pulumi.StringArrayInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput }
The set of arguments for constructing a SubnetGroup resource.
func (SubnetGroupArgs) ElementType ¶
func (SubnetGroupArgs) ElementType() reflect.Type
type SubnetGroupArray ¶
type SubnetGroupArray []SubnetGroupInput
func (SubnetGroupArray) ElementType ¶
func (SubnetGroupArray) ElementType() reflect.Type
func (SubnetGroupArray) ToSubnetGroupArrayOutput ¶
func (i SubnetGroupArray) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
func (SubnetGroupArray) ToSubnetGroupArrayOutputWithContext ¶
func (i SubnetGroupArray) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
type SubnetGroupArrayInput ¶
type SubnetGroupArrayInput interface { pulumi.Input ToSubnetGroupArrayOutput() SubnetGroupArrayOutput ToSubnetGroupArrayOutputWithContext(context.Context) SubnetGroupArrayOutput }
SubnetGroupArrayInput is an input type that accepts SubnetGroupArray and SubnetGroupArrayOutput values. You can construct a concrete instance of `SubnetGroupArrayInput` via:
SubnetGroupArray{ SubnetGroupArgs{...} }
type SubnetGroupArrayOutput ¶
type SubnetGroupArrayOutput struct{ *pulumi.OutputState }
func (SubnetGroupArrayOutput) ElementType ¶
func (SubnetGroupArrayOutput) ElementType() reflect.Type
func (SubnetGroupArrayOutput) Index ¶
func (o SubnetGroupArrayOutput) Index(i pulumi.IntInput) SubnetGroupOutput
func (SubnetGroupArrayOutput) ToSubnetGroupArrayOutput ¶
func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutput() SubnetGroupArrayOutput
func (SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext ¶
func (o SubnetGroupArrayOutput) ToSubnetGroupArrayOutputWithContext(ctx context.Context) SubnetGroupArrayOutput
type SubnetGroupInput ¶
type SubnetGroupInput interface { pulumi.Input ToSubnetGroupOutput() SubnetGroupOutput ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput }
type SubnetGroupMap ¶
type SubnetGroupMap map[string]SubnetGroupInput
func (SubnetGroupMap) ElementType ¶
func (SubnetGroupMap) ElementType() reflect.Type
func (SubnetGroupMap) ToSubnetGroupMapOutput ¶
func (i SubnetGroupMap) ToSubnetGroupMapOutput() SubnetGroupMapOutput
func (SubnetGroupMap) ToSubnetGroupMapOutputWithContext ¶
func (i SubnetGroupMap) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
type SubnetGroupMapInput ¶
type SubnetGroupMapInput interface { pulumi.Input ToSubnetGroupMapOutput() SubnetGroupMapOutput ToSubnetGroupMapOutputWithContext(context.Context) SubnetGroupMapOutput }
SubnetGroupMapInput is an input type that accepts SubnetGroupMap and SubnetGroupMapOutput values. You can construct a concrete instance of `SubnetGroupMapInput` via:
SubnetGroupMap{ "key": SubnetGroupArgs{...} }
type SubnetGroupMapOutput ¶
type SubnetGroupMapOutput struct{ *pulumi.OutputState }
func (SubnetGroupMapOutput) ElementType ¶
func (SubnetGroupMapOutput) ElementType() reflect.Type
func (SubnetGroupMapOutput) MapIndex ¶
func (o SubnetGroupMapOutput) MapIndex(k pulumi.StringInput) SubnetGroupOutput
func (SubnetGroupMapOutput) ToSubnetGroupMapOutput ¶
func (o SubnetGroupMapOutput) ToSubnetGroupMapOutput() SubnetGroupMapOutput
func (SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext ¶
func (o SubnetGroupMapOutput) ToSubnetGroupMapOutputWithContext(ctx context.Context) SubnetGroupMapOutput
type SubnetGroupOutput ¶
type SubnetGroupOutput struct{ *pulumi.OutputState }
func (SubnetGroupOutput) ElementType ¶
func (SubnetGroupOutput) ElementType() reflect.Type
func (SubnetGroupOutput) ToSubnetGroupOutput ¶
func (o SubnetGroupOutput) ToSubnetGroupOutput() SubnetGroupOutput
func (SubnetGroupOutput) ToSubnetGroupOutputWithContext ¶
func (o SubnetGroupOutput) ToSubnetGroupOutputWithContext(ctx context.Context) SubnetGroupOutput
type SubnetGroupState ¶
type SubnetGroupState struct { // The ARN of the subnet group. Arn pulumi.StringPtrInput Description pulumi.StringPtrInput Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // Set of VPC Subnet ID-s for the subnet group. At least one subnet must be provided. SubnetIds pulumi.StringArrayInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // The VPC in which the subnet group exists. VpcId pulumi.StringPtrInput }
func (SubnetGroupState) ElementType ¶
func (SubnetGroupState) ElementType() reflect.Type
type User ¶
type User struct { pulumi.CustomResourceState // The access permissions string used for this user. AccessString pulumi.StringOutput `pulumi:"accessString"` // The ARN of the user. Arn pulumi.StringOutput `pulumi:"arn"` // Denotes the user's authentication properties. Detailed below. AuthenticationMode UserAuthenticationModeOutput `pulumi:"authenticationMode"` // The minimum engine version supported for the user. // * `authenticationMode` configuration block MinimumEngineVersion pulumi.StringOutput `pulumi:"minimumEngineVersion"` // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapOutput `pulumi:"tags"` // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"` // Name of the MemoryDB user. Up to 40 characters. UserName pulumi.StringOutput `pulumi:"userName"` }
## Import
Use the `user_name` to import a user. For example
```sh
$ pulumi import aws:memorydb/user:User example my-user
```
The `passwords` are not available for imported resources, as this information cannot be read back from the MemoryDB API.
func GetUser ¶
func GetUser(ctx *pulumi.Context, name string, id pulumi.IDInput, state *UserState, opts ...pulumi.ResourceOption) (*User, error)
GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewUser ¶
func NewUser(ctx *pulumi.Context, name string, args *UserArgs, opts ...pulumi.ResourceOption) (*User, error)
NewUser registers a new resource with the given unique name, arguments, and options.
func (*User) ElementType ¶
func (*User) ToUserOutput ¶
func (i *User) ToUserOutput() UserOutput
func (*User) ToUserOutputWithContext ¶
func (i *User) ToUserOutputWithContext(ctx context.Context) UserOutput
type UserArgs ¶
type UserArgs struct { // The access permissions string used for this user. AccessString pulumi.StringInput // Denotes the user's authentication properties. Detailed below. AuthenticationMode UserAuthenticationModeInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // Name of the MemoryDB user. Up to 40 characters. UserName pulumi.StringInput }
The set of arguments for constructing a User resource.
func (UserArgs) ElementType ¶
type UserArray ¶
type UserArray []UserInput
func (UserArray) ElementType ¶
func (UserArray) ToUserArrayOutput ¶
func (i UserArray) ToUserArrayOutput() UserArrayOutput
func (UserArray) ToUserArrayOutputWithContext ¶
func (i UserArray) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput
type UserArrayInput ¶
type UserArrayInput interface { pulumi.Input ToUserArrayOutput() UserArrayOutput ToUserArrayOutputWithContext(context.Context) UserArrayOutput }
UserArrayInput is an input type that accepts UserArray and UserArrayOutput values. You can construct a concrete instance of `UserArrayInput` via:
UserArray{ UserArgs{...} }
type UserArrayOutput ¶
type UserArrayOutput struct{ *pulumi.OutputState }
func (UserArrayOutput) ElementType ¶
func (UserArrayOutput) ElementType() reflect.Type
func (UserArrayOutput) Index ¶
func (o UserArrayOutput) Index(i pulumi.IntInput) UserOutput
func (UserArrayOutput) ToUserArrayOutput ¶
func (o UserArrayOutput) ToUserArrayOutput() UserArrayOutput
func (UserArrayOutput) ToUserArrayOutputWithContext ¶
func (o UserArrayOutput) ToUserArrayOutputWithContext(ctx context.Context) UserArrayOutput
type UserAuthenticationMode ¶
type UserAuthenticationMode struct { // The number of passwords belonging to the user. PasswordCount *int `pulumi:"passwordCount"` // The set of passwords used for authentication. You can create up to two passwords for each user. Passwords []string `pulumi:"passwords"` // Indicates whether the user requires a password to authenticate. Must be set to `password`. Type string `pulumi:"type"` }
type UserAuthenticationModeArgs ¶
type UserAuthenticationModeArgs struct { // The number of passwords belonging to the user. PasswordCount pulumi.IntPtrInput `pulumi:"passwordCount"` // The set of passwords used for authentication. You can create up to two passwords for each user. Passwords pulumi.StringArrayInput `pulumi:"passwords"` // Indicates whether the user requires a password to authenticate. Must be set to `password`. Type pulumi.StringInput `pulumi:"type"` }
func (UserAuthenticationModeArgs) ElementType ¶
func (UserAuthenticationModeArgs) ElementType() reflect.Type
func (UserAuthenticationModeArgs) ToUserAuthenticationModeOutput ¶
func (i UserAuthenticationModeArgs) ToUserAuthenticationModeOutput() UserAuthenticationModeOutput
func (UserAuthenticationModeArgs) ToUserAuthenticationModeOutputWithContext ¶
func (i UserAuthenticationModeArgs) ToUserAuthenticationModeOutputWithContext(ctx context.Context) UserAuthenticationModeOutput
func (UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutput ¶
func (i UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
func (UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutputWithContext ¶
func (i UserAuthenticationModeArgs) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
type UserAuthenticationModeInput ¶
type UserAuthenticationModeInput interface { pulumi.Input ToUserAuthenticationModeOutput() UserAuthenticationModeOutput ToUserAuthenticationModeOutputWithContext(context.Context) UserAuthenticationModeOutput }
UserAuthenticationModeInput is an input type that accepts UserAuthenticationModeArgs and UserAuthenticationModeOutput values. You can construct a concrete instance of `UserAuthenticationModeInput` via:
UserAuthenticationModeArgs{...}
type UserAuthenticationModeOutput ¶
type UserAuthenticationModeOutput struct{ *pulumi.OutputState }
func (UserAuthenticationModeOutput) ElementType ¶
func (UserAuthenticationModeOutput) ElementType() reflect.Type
func (UserAuthenticationModeOutput) PasswordCount ¶
func (o UserAuthenticationModeOutput) PasswordCount() pulumi.IntPtrOutput
The number of passwords belonging to the user.
func (UserAuthenticationModeOutput) Passwords ¶
func (o UserAuthenticationModeOutput) Passwords() pulumi.StringArrayOutput
The set of passwords used for authentication. You can create up to two passwords for each user.
func (UserAuthenticationModeOutput) ToUserAuthenticationModeOutput ¶
func (o UserAuthenticationModeOutput) ToUserAuthenticationModeOutput() UserAuthenticationModeOutput
func (UserAuthenticationModeOutput) ToUserAuthenticationModeOutputWithContext ¶
func (o UserAuthenticationModeOutput) ToUserAuthenticationModeOutputWithContext(ctx context.Context) UserAuthenticationModeOutput
func (UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutput ¶
func (o UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
func (UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutputWithContext ¶
func (o UserAuthenticationModeOutput) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
func (UserAuthenticationModeOutput) Type ¶
func (o UserAuthenticationModeOutput) Type() pulumi.StringOutput
Indicates whether the user requires a password to authenticate. Must be set to `password`.
type UserAuthenticationModePtrInput ¶
type UserAuthenticationModePtrInput interface { pulumi.Input ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput ToUserAuthenticationModePtrOutputWithContext(context.Context) UserAuthenticationModePtrOutput }
UserAuthenticationModePtrInput is an input type that accepts UserAuthenticationModeArgs, UserAuthenticationModePtr and UserAuthenticationModePtrOutput values. You can construct a concrete instance of `UserAuthenticationModePtrInput` via:
UserAuthenticationModeArgs{...} or: nil
func UserAuthenticationModePtr ¶
func UserAuthenticationModePtr(v *UserAuthenticationModeArgs) UserAuthenticationModePtrInput
type UserAuthenticationModePtrOutput ¶
type UserAuthenticationModePtrOutput struct{ *pulumi.OutputState }
func (UserAuthenticationModePtrOutput) Elem ¶
func (o UserAuthenticationModePtrOutput) Elem() UserAuthenticationModeOutput
func (UserAuthenticationModePtrOutput) ElementType ¶
func (UserAuthenticationModePtrOutput) ElementType() reflect.Type
func (UserAuthenticationModePtrOutput) PasswordCount ¶
func (o UserAuthenticationModePtrOutput) PasswordCount() pulumi.IntPtrOutput
The number of passwords belonging to the user.
func (UserAuthenticationModePtrOutput) Passwords ¶
func (o UserAuthenticationModePtrOutput) Passwords() pulumi.StringArrayOutput
The set of passwords used for authentication. You can create up to two passwords for each user.
func (UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutput ¶
func (o UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutput() UserAuthenticationModePtrOutput
func (UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutputWithContext ¶
func (o UserAuthenticationModePtrOutput) ToUserAuthenticationModePtrOutputWithContext(ctx context.Context) UserAuthenticationModePtrOutput
func (UserAuthenticationModePtrOutput) Type ¶
func (o UserAuthenticationModePtrOutput) Type() pulumi.StringPtrOutput
Indicates whether the user requires a password to authenticate. Must be set to `password`.
type UserInput ¶
type UserInput interface { pulumi.Input ToUserOutput() UserOutput ToUserOutputWithContext(ctx context.Context) UserOutput }
type UserMap ¶
func (UserMap) ElementType ¶
func (UserMap) ToUserMapOutput ¶
func (i UserMap) ToUserMapOutput() UserMapOutput
func (UserMap) ToUserMapOutputWithContext ¶
func (i UserMap) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput
type UserMapInput ¶
type UserMapInput interface { pulumi.Input ToUserMapOutput() UserMapOutput ToUserMapOutputWithContext(context.Context) UserMapOutput }
UserMapInput is an input type that accepts UserMap and UserMapOutput values. You can construct a concrete instance of `UserMapInput` via:
UserMap{ "key": UserArgs{...} }
type UserMapOutput ¶
type UserMapOutput struct{ *pulumi.OutputState }
func (UserMapOutput) ElementType ¶
func (UserMapOutput) ElementType() reflect.Type
func (UserMapOutput) MapIndex ¶
func (o UserMapOutput) MapIndex(k pulumi.StringInput) UserOutput
func (UserMapOutput) ToUserMapOutput ¶
func (o UserMapOutput) ToUserMapOutput() UserMapOutput
func (UserMapOutput) ToUserMapOutputWithContext ¶
func (o UserMapOutput) ToUserMapOutputWithContext(ctx context.Context) UserMapOutput
type UserOutput ¶
type UserOutput struct{ *pulumi.OutputState }
func (UserOutput) ElementType ¶
func (UserOutput) ElementType() reflect.Type
func (UserOutput) ToUserOutput ¶
func (o UserOutput) ToUserOutput() UserOutput
func (UserOutput) ToUserOutputWithContext ¶
func (o UserOutput) ToUserOutputWithContext(ctx context.Context) UserOutput
type UserState ¶
type UserState struct { // The access permissions string used for this user. AccessString pulumi.StringPtrInput // The ARN of the user. Arn pulumi.StringPtrInput // Denotes the user's authentication properties. Detailed below. AuthenticationMode UserAuthenticationModePtrInput // The minimum engine version supported for the user. // * `authenticationMode` configuration block MinimumEngineVersion pulumi.StringPtrInput // A map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. Tags pulumi.StringMapInput // A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-configuration-block). TagsAll pulumi.StringMapInput // Name of the MemoryDB user. Up to 40 characters. UserName pulumi.StringPtrInput }