@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
112 lines (111 loc) • 4.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
*/
export declare function getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>;
export interface GetClusterArgs {
/**
* The name of the cluster. This value must be unique as it also serves as the cluster identifier.
*/
clusterName: string;
}
export interface GetClusterResult {
/**
* The name of the Access Control List to associate with the cluster.
*/
readonly aclName?: string;
/**
* The Amazon Resource Name (ARN) of the cluster.
*/
readonly arn?: string;
/**
* A flag that enables automatic minor version upgrade when set to true.
*
* You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.
*/
readonly autoMinorVersionUpgrade?: boolean;
/**
* The cluster endpoint.
*/
readonly clusterEndpoint?: outputs.memorydb.ClusterEndpoint;
/**
* An optional description of the cluster.
*/
readonly description?: string;
/**
* The engine type used by the cluster.
*/
readonly engine?: string;
/**
* The Redis engine version used by the cluster.
*/
readonly engineVersion?: string;
/**
* For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as `cluster info` and `cluster nodes` which are used by clients to connect to the nodes in the cluster.
*/
readonly ipDiscovery?: enums.memorydb.ClusterSupportedIpDiscoveryTypes;
/**
* 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.
*/
readonly maintenanceWindow?: string;
/**
* The compute and memory capacity of the nodes in the cluster.
*/
readonly nodeType?: string;
/**
* The number of replicas to apply to each shard. The limit is 5.
*/
readonly numReplicasPerShard?: number;
/**
* The number of shards the cluster will contain.
*/
readonly numShards?: number;
/**
* The name of the parameter group associated with the cluster.
*/
readonly parameterGroupName?: string;
/**
* The status of the parameter group used by the cluster.
*/
readonly parameterGroupStatus?: string;
/**
* One or more Amazon VPC security groups associated with this cluster.
*/
readonly securityGroupIds?: string[];
/**
* The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
*/
readonly snapshotRetentionLimit?: number;
/**
* The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
*/
readonly snapshotWindow?: string;
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
*/
readonly snsTopicArn?: string;
/**
* The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
*/
readonly snsTopicStatus?: string;
/**
* The status of the cluster. For example, Available, Updating, Creating.
*/
readonly status?: string;
/**
* An array of key-value pairs to apply to this cluster.
*/
readonly tags?: outputs.Tag[];
}
/**
* The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
*/
export declare function getClusterOutput(args: GetClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetClusterResult>;
export interface GetClusterOutputArgs {
/**
* The name of the cluster. This value must be unique as it also serves as the cluster identifier.
*/
clusterName: pulumi.Input<string>;
}