Cluster

public struct Cluster : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

    Declaration

    Swift

    public let allowVersionUpgrade: Bool?

  • The number of days that automatic cluster snapshots are retained.

    Declaration

    Swift

    public let automatedSnapshotRetentionPeriod: Int?

  • The name of the Availability Zone in which the cluster is located.

    Declaration

    Swift

    public let availabilityZone: String?

  • The availability status of the cluster for queries. Possible values are the following: Available - The cluster is available for queries. Unavailable - The cluster is not available for queries. Maintenance - The cluster is intermittently available for queries due to maintenance activities. Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. Failed - The cluster failed and is not available for queries.

    Declaration

    Swift

    public let clusterAvailabilityStatus: String?

  • The date and time that the cluster was created.

    Declaration

    Swift

    public let clusterCreateTime: TimeStamp?

  • The unique identifier of the cluster.

    Declaration

    Swift

    public let clusterIdentifier: String?

  • The nodes in the cluster.

    Declaration

    Swift

    public let clusterNodes: [ClusterNode]?

  • The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

    Declaration

    Swift

    public let clusterParameterGroups: [ClusterParameterGroupStatus]?

  • The public key for the cluster.

    Declaration

    Swift

    public let clusterPublicKey: String?

  • The specific revision number of the database in the cluster.

    Declaration

    Swift

    public let clusterRevisionNumber: String?

  • A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

    Declaration

    Swift

    public let clusterSecurityGroups: [ClusterSecurityGroupMembership]?

  • A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

    Declaration

    Swift

    public let clusterSnapshotCopyStatus: ClusterSnapshotCopyStatus?

  • The current state of the cluster. Possible values are the following: available available, prep-for-resize available, resize-cleanup cancelling-resize creating deleting final-snapshot hardware-failure incompatible-hsm incompatible-network incompatible-parameters incompatible-restore modifying paused rebooting renaming resizing rotating-keys storage-full updating-hsm

    Declaration

    Swift

    public let clusterStatus: String?

  • The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

    Declaration

    Swift

    public let clusterSubnetGroupName: String?

  • The version ID of the Amazon Redshift engine that is running on the cluster.

    Declaration

    Swift

    public let clusterVersion: String?

  • Undocumented

    Declaration

    Swift

    public let dataTransferProgress: DataTransferProgress?

  • The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

    Declaration

    Swift

    public let dBName: String?

  • Describes a group of DeferredMaintenanceWindow objects.

    Declaration

    Swift

    public let deferredMaintenanceWindows: [DeferredMaintenanceWindow]?

  • The status of the elastic IP (EIP) address.

    Declaration

    Swift

    public let elasticIpStatus: ElasticIpStatus?

  • The number of nodes that you can resize the cluster to with the elastic resize method.

    Declaration

    Swift

    public let elasticResizeNumberOfNodeOptions: String?

  • A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

    Declaration

    Swift

    public let encrypted: Bool?

  • The connection endpoint.

    Declaration

    Swift

    public let endpoint: Endpoint?

  • An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true, enhanced VPC routing is enabled. Default: false

    Declaration

    Swift

    public let enhancedVpcRouting: Bool?

  • The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

    Declaration

    Swift

    public let expectedNextSnapshotScheduleTime: TimeStamp?

  • The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: OnTrack - The next snapshot is expected to be taken on time. Pending - The next snapshot is pending to be taken.

    Declaration

    Swift

    public let expectedNextSnapshotScheduleTimeStatus: String?

  • A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying

    Declaration

    Swift

    public let hsmStatus: HsmStatus?

  • A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

    Declaration

    Swift

    public let iamRoles: [ClusterIamRole]?

  • The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

    Declaration

    Swift

    public let kmsKeyId: String?

  • The name of the maintenance track for the cluster.

    Declaration

    Swift

    public let maintenanceTrackName: String?

  • The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn’t change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.

    Declaration

    Swift

    public let manualSnapshotRetentionPeriod: Int?

  • The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

    Declaration

    Swift

    public let masterUsername: String?

  • The status of a modify operation, if any, initiated for the cluster.

    Declaration

    Swift

    public let modifyStatus: String?

  • The date and time in UTC when system maintenance can begin.

    Declaration

    Swift

    public let nextMaintenanceWindowStartTime: TimeStamp?

  • The node type for the nodes in the cluster.

    Declaration

    Swift

    public let nodeType: String?

  • The number of compute nodes in the cluster.

    Declaration

    Swift

    public let numberOfNodes: Int?

  • Cluster operations that are waiting to be started.

    Declaration

    Swift

    public let pendingActions: [String]?

  • A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

    Declaration

    Swift

    public let pendingModifiedValues: PendingModifiedValues?

  • The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

  • A boolean value that, if true, indicates that the cluster can be accessed from a public network.

    Declaration

    Swift

    public let publiclyAccessible: Bool?

  • Returns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize

    Declaration

    Swift

    public let resizeInfo: ResizeInfo?

  • A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

    Declaration

    Swift

    public let restoreStatus: RestoreStatus?

  • A unique identifier for the cluster snapshot schedule.

    Declaration

    Swift

    public let snapshotScheduleIdentifier: String?

  • The current state of the cluster snapshot schedule.

    Declaration

    Swift

    public let snapshotScheduleState: ScheduleState?

  • The list of tags for the cluster.

    Declaration

    Swift

    public let tags: [Tag]?

  • The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    Declaration

    Swift

    public let vpcId: String?

  • A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

    Declaration

    Swift

    public let vpcSecurityGroups: [VpcSecurityGroupMembership]?
  • init(allowVersionUpgrade:automatedSnapshotRetentionPeriod:availabilityZone:clusterAvailabilityStatus:clusterCreateTime:clusterIdentifier:clusterNodes:clusterParameterGroups:clusterPublicKey:clusterRevisionNumber:clusterSecurityGroups:clusterSnapshotCopyStatus:clusterStatus:clusterSubnetGroupName:clusterVersion:dataTransferProgress:dBName:deferredMaintenanceWindows:elasticIpStatus:elasticResizeNumberOfNodeOptions:encrypted:endpoint:enhancedVpcRouting:expectedNextSnapshotScheduleTime:expectedNextSnapshotScheduleTimeStatus:hsmStatus:iamRoles:kmsKeyId:maintenanceTrackName:manualSnapshotRetentionPeriod:masterUsername:modifyStatus:nextMaintenanceWindowStartTime:nodeType:numberOfNodes:pendingActions:pendingModifiedValues:preferredMaintenanceWindow:publiclyAccessible:resizeInfo:restoreStatus:snapshotScheduleIdentifier:snapshotScheduleState:tags:vpcId:vpcSecurityGroups:)

    Undocumented

    Declaration

    Swift

    public init(allowVersionUpgrade: Bool? = nil, automatedSnapshotRetentionPeriod: Int? = nil, availabilityZone: String? = nil, clusterAvailabilityStatus: String? = nil, clusterCreateTime: TimeStamp? = nil, clusterIdentifier: String? = nil, clusterNodes: [ClusterNode]? = nil, clusterParameterGroups: [ClusterParameterGroupStatus]? = nil, clusterPublicKey: String? = nil, clusterRevisionNumber: String? = nil, clusterSecurityGroups: [ClusterSecurityGroupMembership]? = nil, clusterSnapshotCopyStatus: ClusterSnapshotCopyStatus? = nil, clusterStatus: String? = nil, clusterSubnetGroupName: String? = nil, clusterVersion: String? = nil, dataTransferProgress: DataTransferProgress? = nil, dBName: String? = nil, deferredMaintenanceWindows: [DeferredMaintenanceWindow]? = nil, elasticIpStatus: ElasticIpStatus? = nil, elasticResizeNumberOfNodeOptions: String? = nil, encrypted: Bool? = nil, endpoint: Endpoint? = nil, enhancedVpcRouting: Bool? = nil, expectedNextSnapshotScheduleTime: TimeStamp? = nil, expectedNextSnapshotScheduleTimeStatus: String? = nil, hsmStatus: HsmStatus? = nil, iamRoles: [ClusterIamRole]? = nil, kmsKeyId: String? = nil, maintenanceTrackName: String? = nil, manualSnapshotRetentionPeriod: Int? = nil, masterUsername: String? = nil, modifyStatus: String? = nil, nextMaintenanceWindowStartTime: TimeStamp? = nil, nodeType: String? = nil, numberOfNodes: Int? = nil, pendingActions: [String]? = nil, pendingModifiedValues: PendingModifiedValues? = nil, preferredMaintenanceWindow: String? = nil, publiclyAccessible: Bool? = nil, resizeInfo: ResizeInfo? = nil, restoreStatus: RestoreStatus? = nil, snapshotScheduleIdentifier: String? = nil, snapshotScheduleState: ScheduleState? = nil, tags: [Tag]? = nil, vpcId: String? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)