CacheCluster

public struct CacheCluster : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    The ARN (Amazon Resource Name) of the cache cluster.

    Declaration

    Swift

    public let arn: String?

  • A flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false

    Declaration

    Swift

    public let atRestEncryptionEnabled: Bool?

  • A flag that enables using an AuthToken (password) when issuing Redis commands. Default: false

    Declaration

    Swift

    public let authTokenEnabled: Bool?

  • The date the auth token was last modified

    Declaration

    Swift

    public let authTokenLastModifiedDate: TimeStamp?

  • This parameter is currently disabled.

    Declaration

    Swift

    public let autoMinorVersionUpgrade: Bool?

  • The date and time when the cluster was created.

    Declaration

    Swift

    public let cacheClusterCreateTime: TimeStamp?

  • The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

    Declaration

    Swift

    public let cacheClusterId: String?

  • The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

    Declaration

    Swift

    public let cacheClusterStatus: String?

  • A list of cache nodes that are members of the cluster.

    Declaration

    Swift

    public let cacheNodes: [CacheNode]?

  • The name of the compute and memory capacity node type for the cluster. The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. General purpose: Current generation: M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge Additional node type info All current generation instance types are created in Amazon VPC by default. Redis append-only files (AOF) are not supported for T1 or T2 instances. Redis Multi-AZ with automatic failover is not supported on T1 instances. Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    Declaration

    Swift

    public let cacheNodeType: String?

  • Status of the cache parameter group.

    Declaration

    Swift

    public let cacheParameterGroup: CacheParameterGroupStatus?

  • A list of cache security group elements, composed of name and status sub-elements.

    Declaration

    Swift

    public let cacheSecurityGroups: [CacheSecurityGroupMembership]?

  • The name of the cache subnet group associated with the cluster.

    Declaration

    Swift

    public let cacheSubnetGroupName: String?

  • The URL of the web page where you can download the latest ElastiCache client library.

    Declaration

    Swift

    public let clientDownloadLandingPage: String?

  • Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it. Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

    Declaration

    Swift

    public let configurationEndpoint: Endpoint?

  • The name of the cache engine (memcached or redis) to be used for this cluster.

    Declaration

    Swift

    public let engine: String?

  • The version of the cache engine that is used in this cluster.

    Declaration

    Swift

    public let engineVersion: String?

  • Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

    Declaration

    Swift

    public let notificationConfiguration: NotificationConfiguration?

  • The number of cache nodes in the cluster. For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

    Declaration

    Swift

    public let numCacheNodes: Int?

  • Undocumented

    Declaration

    Swift

    public let pendingModifiedValues: PendingModifiedValues?

  • The name of the Availability Zone in which the cluster is located or “Multiple” if the cache nodes are located in different Availability Zones.

    Declaration

    Swift

    public let preferredAvailabilityZone: String?

  • 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. Valid values for ddd are: sun mon tue wed thu fri sat Example: sun:23:00-mon:01:30

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

  • The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

    Declaration

    Swift

    public let replicationGroupId: String?

  • A list of VPC Security Groups associated with the cluster.

    Declaration

    Swift

    public let securityGroups: [SecurityGroupMembership]?

  • The number of days for which ElastiCache retains automatic cluster 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. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    Declaration

    Swift

    public let snapshotRetentionLimit: Int?

  • The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster. Example: 05:00-09:00

    Declaration

    Swift

    public let snapshotWindow: String?

  • A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. Default: false

    Declaration

    Swift

    public let transitEncryptionEnabled: Bool?

  • Undocumented

    Declaration

    Swift

    public init(arn: String? = nil, atRestEncryptionEnabled: Bool? = nil, authTokenEnabled: Bool? = nil, authTokenLastModifiedDate: TimeStamp? = nil, autoMinorVersionUpgrade: Bool? = nil, cacheClusterCreateTime: TimeStamp? = nil, cacheClusterId: String? = nil, cacheClusterStatus: String? = nil, cacheNodes: [CacheNode]? = nil, cacheNodeType: String? = nil, cacheParameterGroup: CacheParameterGroupStatus? = nil, cacheSecurityGroups: [CacheSecurityGroupMembership]? = nil, cacheSubnetGroupName: String? = nil, clientDownloadLandingPage: String? = nil, configurationEndpoint: Endpoint? = nil, engine: String? = nil, engineVersion: String? = nil, notificationConfiguration: NotificationConfiguration? = nil, numCacheNodes: Int? = nil, pendingModifiedValues: PendingModifiedValues? = nil, preferredAvailabilityZone: String? = nil, preferredMaintenanceWindow: String? = nil, replicationGroupId: String? = nil, securityGroups: [SecurityGroupMembership]? = nil, snapshotRetentionLimit: Int? = nil, snapshotWindow: String? = nil, transitEncryptionEnabled: Bool? = nil)