Network.AWS.Redshift.Types

Service Configuration

redshift :: Service

API version '2012-12-01' of the Amazon Redshift SDK configuration.

Errors

_ClusterSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_InvalidS3KeyPrefixFault :: AsError a => Getting (First ServiceError) a ServiceError

The string specified for the logging S3 key prefix does not comply with the documented constraints.

_SourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified Amazon Redshift event source could not be found.

_AuthorizationQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The authorization quota for the cluster security group has been reached.

_CopyToRegionDisabledFault :: AsError a => Getting (First ServiceError) a ServiceError

Cross-region snapshot copy was temporarily disabled. Try your request again.

_LimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The encryption key has exceeded its grant limit in AWS KMS.

_InvalidClusterSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The state of the cluster security group is not available.

_ClusterSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A cluster security group with the same name already exists.

_ClusterSnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The snapshot identifier does not refer to an existing cluster snapshot.

_InvalidElasticIPFault :: AsError a => Getting (First ServiceError) a ServiceError

The Elastic IP (EIP) is invalid or cannot be found.

_HSMConfigurationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

There is no Amazon Redshift HSM configuration with the specified identifier.

_AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

_SubscriptionCategoryNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.

_HSMConfigurationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

_SubscriptionNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

An Amazon Redshift event notification subscription with the specified name does not exist.

_InvalidS3BucketNameFault :: AsError a => Getting (First ServiceError) a ServiceError

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

_ClusterSnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The value specified as a snapshot identifier is already used by an existing snapshot.

_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError

The requested subnet is not valid, or not all of the subnets are in the same VPC.

_InvalidHSMConfigurationStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

_SnapshotCopyAlreadyDisabledFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster already has cross-region snapshot copy disabled.

_ClusterQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_HSMClientCertificateQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_ClusterParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The parameter group name does not refer to an existing parameter group.

_SnapshotCopyGrantQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The AWS account has exceeded the maximum number of snapshot copy grants in this region.

_NumberOfNodesPerClusterLimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The operation would exceed the number of nodes allowed for a cluster.

_SnapshotCopyAlreadyEnabledFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster already has cross-region snapshot copy enabled.

_ClusterParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A cluster parameter group with the same name already exists.

_SnapshotCopyDisabledFault :: AsError a => Getting (First ServiceError) a ServiceError

Cross-region snapshot copy was temporarily disabled. Try your request again.

_ResizeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

A resize operation for the specified cluster is not found.

_HSMClientCertificateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

There is no Amazon Redshift HSM client certificate with the specified identifier.

_SNSTopicARNNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

_ClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The ClusterIdentifier parameter does not refer to an existing cluster.

_ClusterParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_SnapshotCopyGrantAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The snapshot copy grant can't be created because a grant with the same name already exists.

_SNSNoAuthorizationFault :: AsError a => Getting (First ServiceError) a ServiceError

You do not have permission to publish to the specified Amazon SNS topic.

_InvalidClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified cluster is not in the available state.

_SnapshotCopyGrantNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

_HSMConfigurationQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_ClusterSnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would result in the user exceeding the allowed number of cluster snapshots.

_InsufficientClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError

The number of nodes specified exceeds the allotted capacity of the cluster.

_SNSInvalidTopicFault :: AsError a => Getting (First ServiceError) a ServiceError

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

_UnsupportedOptionFault :: AsError a => Getting (First ServiceError) a ServiceError

A request option was specified that is not supported.

_SubscriptionAlreadyExistFault :: AsError a => Getting (First ServiceError) a ServiceError

There is already an existing event notification subscription with the specified name.

_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster subnet group does not cover all Availability Zones.

_ClusterSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster subnet group name does not refer to an existing cluster subnet group.

_BucketNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

Could not find the specified S3 bucket.

_InvalidSubscriptionStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.

_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.

_InvalidClusterSubnetGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster subnet group cannot be deleted because it is in use.

_UnsupportedOperationFault :: AsError a => Getting (First ServiceError) a ServiceError

The requested operation isn't supported.

_ClusterSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

A ClusterSubnetGroupName is already used by an existing cluster subnet group.

_InvalidClusterSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The state of the cluster snapshot is not available, or other accounts are authorized to access the snapshot.

_ClusterSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster security group name does not refer to an existing cluster security group.

_ReservedNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified reserved compute node not found.

_ReservedNodeOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

Specified offering does not exist.

_InvalidClusterSubnetStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The state of the subnet is invalid.

_IncompatibleOrderableOptions :: AsError a => Getting (First ServiceError) a ServiceError

The specified options are incompatible.

_EventSubscriptionQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_InvalidClusterParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

_ReservedNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

User already has a reservation with the given identifier.

_InvalidRestoreFault :: AsError a => Getting (First ServiceError) a ServiceError

The restore is invalid.

_ResourceNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The resource could not be found.

_SubscriptionEventIdNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

An Amazon Redshift event with the specified event ID does not exist.

_InvalidSnapshotCopyGrantStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The snapshot copy grant can't be deleted because it is used by one or more clusters.

_UnknownSnapshotCopyRegionFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified region is incorrect or does not exist.

_ReservedNodeQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_ClusterSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_ClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

The account already has a cluster with the given identifier.

_AccessToSnapshotDeniedFault :: AsError a => Getting (First ServiceError) a ServiceError

The owner of the specified snapshot has not authorized your account to access the snapshot.

_TagLimitExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request exceeds the limit of 10 tags for the resource.

_NumberOfNodesQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

_HSMClientCertificateAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

_InvalidHSMClientCertificateStateFault :: AsError a => Getting (First ServiceError) a ServiceError

The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

_SubnetAlreadyInUse :: AsError a => Getting (First ServiceError) a ServiceError

A specified subnet is already in use by another cluster.

_SubscriptionSeverityNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError

The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.

_UnauthorizedOperation :: AsError a => Getting (First ServiceError) a ServiceError

Your account is not authorized to perform the requested operation.

_InvalidTagFault :: AsError a => Getting (First ServiceError) a ServiceError

The tag is invalid.

_InsufficientS3BucketPolicyFault :: AsError a => Getting (First ServiceError) a ServiceError

The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.

_ClusterSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError

The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

ParameterApplyType

data ParameterApplyType

Constructors

Dynamic

Static

Instances

Bounded ParameterApplyType

Enum ParameterApplyType

Eq ParameterApplyType

Data ParameterApplyType

Ord ParameterApplyType

Read ParameterApplyType

Show ParameterApplyType

Generic ParameterApplyType

Hashable ParameterApplyType

ToHeader ParameterApplyType

FromXML ParameterApplyType

ToQuery ParameterApplyType

ToByteString ParameterApplyType

FromText ParameterApplyType

ToText ParameterApplyType

type Rep ParameterApplyType

SourceType

data SourceType

Constructors

Cluster

ClusterParameterGroup

ClusterSecurityGroup

ClusterSnapshot

Instances

Bounded SourceType

Enum SourceType

Eq SourceType

Data SourceType

Ord SourceType

Read SourceType

Show SourceType

Generic SourceType

Hashable SourceType

ToHeader SourceType

FromXML SourceType

ToQuery SourceType

ToByteString SourceType

FromText SourceType

ToText SourceType

type Rep SourceType

AccountWithRestoreAccess

data AccountWithRestoreAccess

Describes an AWS customer account authorized to restore a snapshot.

See: accountWithRestoreAccess smart constructor.

Instances

Eq AccountWithRestoreAccess

Data AccountWithRestoreAccess

Read AccountWithRestoreAccess

Show AccountWithRestoreAccess

Generic AccountWithRestoreAccess

FromXML AccountWithRestoreAccess

type Rep AccountWithRestoreAccess

accountWithRestoreAccess :: AccountWithRestoreAccess

Creates a value of AccountWithRestoreAccess with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• awraAccountId

awraAccountId :: Lens' AccountWithRestoreAccess (Maybe Text)

The identifier of an AWS customer account authorized to restore a snapshot.

AvailabilityZone

data AvailabilityZone

Describes an availability zone.

See: availabilityZone smart constructor.

Instances

Eq AvailabilityZone

Data AvailabilityZone

Read AvailabilityZone

Show AvailabilityZone

Generic AvailabilityZone

FromXML AvailabilityZone

type Rep AvailabilityZone

availabilityZone :: AvailabilityZone

Creates a value of AvailabilityZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• azName

azName :: Lens' AvailabilityZone (Maybe Text)

The name of the availability zone.

Cluster

data Cluster

Describes a cluster.

See: cluster smart constructor.

Instances

Eq Cluster

Data Cluster

Read Cluster

Show Cluster

Generic Cluster

FromXML Cluster

type Rep Cluster

cluster :: Cluster

Creates a value of Cluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cRestoreStatus
• cClusterSnapshotCopyStatus
• cClusterRevisionNumber
• cPubliclyAccessible
• cMasterUsername
• cVPCId
• cClusterSecurityGroups
• cAutomatedSnapshotRetentionPeriod
• cEncrypted
• cClusterSubnetGroupName
• cClusterIdentifier
• cNumberOfNodes
• cClusterPublicKey
• cPreferredMaintenanceWindow
• cModifyStatus
• cKMSKeyId
• cClusterParameterGroups
• cAvailabilityZone
• cVPCSecurityGroups
• cHSMStatus
• cElasticIPStatus
• cClusterVersion
• cNodeType
• cClusterCreateTime
• cEndpoint
• cAllowVersionUpgrade
• cClusterStatus
• cPendingModifiedValues
• cTags
• cClusterNodes
• cDBName

cRestoreStatus :: Lens' Cluster (Maybe RestoreStatus)

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

cClusterSnapshotCopyStatus :: Lens' Cluster (Maybe ClusterSnapshotCopyStatus)

Returns the destination region and retention period that are configured for cross-region snapshot copy.

cClusterRevisionNumber :: Lens' Cluster (Maybe Text)

The specific revision number of the database in the cluster.

cPubliclyAccessible :: Lens' Cluster (Maybe Bool)

If true, the cluster can be accessed from a public network.

cMasterUsername :: Lens' Cluster (Maybe Text)

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

cVPCId :: Lens' Cluster (Maybe Text)

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

cClusterSecurityGroups :: Lens' Cluster [ClusterSecurityGroupMembership]

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains Name and Status subelements.

Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

cAutomatedSnapshotRetentionPeriod :: Lens' Cluster (Maybe Int)

The number of days that automatic cluster snapshots are retained.

cEncrypted :: Lens' Cluster (Maybe Bool)

If true, data in the cluster is encrypted at rest.

cClusterSubnetGroupName :: Lens' Cluster (Maybe Text)

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

cClusterIdentifier :: Lens' Cluster (Maybe Text)

The unique identifier of the cluster.

cNumberOfNodes :: Lens' Cluster (Maybe Int)

The number of compute nodes in the cluster.

cClusterPublicKey :: Lens' Cluster (Maybe Text)

The public key for the cluster.

cPreferredMaintenanceWindow :: Lens' Cluster (Maybe Text)

The weekly time range (in UTC) during which system maintenance can occur.

cModifyStatus :: Lens' Cluster (Maybe Text)

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

cKMSKeyId :: Lens' Cluster (Maybe Text)

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

cClusterParameterGroups :: Lens' Cluster [ClusterParameterGroupStatus]

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

cAvailabilityZone :: Lens' Cluster (Maybe Text)

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

cVPCSecurityGroups :: Lens' Cluster [VPCSecurityGroupMembership]

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

cHSMStatus :: Lens' Cluster (Maybe HSMStatus)

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Values: active, applying

cElasticIPStatus :: Lens' Cluster (Maybe ElasticIPStatus)

Describes the status of the elastic IP (EIP) address.

cClusterVersion :: Lens' Cluster (Maybe Text)

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

cNodeType :: Lens' Cluster (Maybe Text)

The node type for the nodes in the cluster.

cClusterCreateTime :: Lens' Cluster (Maybe UTCTime)

The date and time that the cluster was created.

cEndpoint :: Lens' Cluster (Maybe Endpoint)

The connection endpoint.

cAllowVersionUpgrade :: Lens' Cluster (Maybe Bool)

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

cClusterStatus :: Lens' Cluster (Maybe Text)

The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.

cPendingModifiedValues :: Lens' Cluster (Maybe PendingModifiedValues)

If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

cTags :: Lens' Cluster [Tag]

The list of tags for the cluster.

cClusterNodes :: Lens' Cluster [ClusterNode]

The nodes in a cluster.

cDBName :: Lens' Cluster (Maybe Text)

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 "dev" was created by default.

ClusterNode

data ClusterNode

The identifier of a node in a cluster.

See: clusterNode smart constructor.

Instances

Eq ClusterNode

Data ClusterNode

Read ClusterNode

Show ClusterNode

Generic ClusterNode

FromXML ClusterNode

type Rep ClusterNode

clusterNode :: ClusterNode

Creates a value of ClusterNode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cnNodeRole
• cnPrivateIPAddress
• cnPublicIPAddress

cnNodeRole :: Lens' ClusterNode (Maybe Text)

Whether the node is a leader node or a compute node.

cnPrivateIPAddress :: Lens' ClusterNode (Maybe Text)

The private IP address of a node within a cluster.

cnPublicIPAddress :: Lens' ClusterNode (Maybe Text)

The public IP address of a node within a cluster.

ClusterParameterGroup

data ClusterParameterGroup

Describes a parameter group.

See: clusterParameterGroup smart constructor.

Instances

Eq ClusterParameterGroup

Data ClusterParameterGroup

Read ClusterParameterGroup

Show ClusterParameterGroup

Generic ClusterParameterGroup

FromXML ClusterParameterGroup

type Rep ClusterParameterGroup

clusterParameterGroup :: ClusterParameterGroup

Creates a value of ClusterParameterGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgParameterGroupFamily
• cpgDescription
• cpgTags
• cpgParameterGroupName

cpgParameterGroupFamily :: Lens' ClusterParameterGroup (Maybe Text)

The name of the cluster parameter group family that this cluster parameter group is compatible with.

cpgDescription :: Lens' ClusterParameterGroup (Maybe Text)

The description of the parameter group.

cpgTags :: Lens' ClusterParameterGroup [Tag]

The list of tags for the cluster parameter group.

cpgParameterGroupName :: Lens' ClusterParameterGroup (Maybe Text)

The name of the cluster parameter group.

ClusterParameterGroupNameMessage

data ClusterParameterGroupNameMessage

Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.

See: clusterParameterGroupNameMessage smart constructor.

Instances

Eq ClusterParameterGroupNameMessage

Data ClusterParameterGroupNameMessage

Read ClusterParameterGroupNameMessage

Show ClusterParameterGroupNameMessage

Generic ClusterParameterGroupNameMessage

FromXML ClusterParameterGroupNameMessage

type Rep ClusterParameterGroupNameMessage

clusterParameterGroupNameMessage :: ClusterParameterGroupNameMessage

Creates a value of ClusterParameterGroupNameMessage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgnmParameterGroupStatus
• cpgnmParameterGroupName

cpgnmParameterGroupStatus :: Lens' ClusterParameterGroupNameMessage (Maybe Text)

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

cpgnmParameterGroupName :: Lens' ClusterParameterGroupNameMessage (Maybe Text)

The name of the cluster parameter group.

ClusterParameterGroupStatus

data ClusterParameterGroupStatus

Describes the status of a parameter group.

See: clusterParameterGroupStatus smart constructor.

Instances

Eq ClusterParameterGroupStatus

Data ClusterParameterGroupStatus

Read ClusterParameterGroupStatus

Show ClusterParameterGroupStatus

Generic ClusterParameterGroupStatus

FromXML ClusterParameterGroupStatus

type Rep ClusterParameterGroupStatus

clusterParameterGroupStatus :: ClusterParameterGroupStatus

Creates a value of ClusterParameterGroupStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpgsClusterParameterStatusList
• cpgsParameterApplyStatus
• cpgsParameterGroupName

cpgsClusterParameterStatusList :: Lens' ClusterParameterGroupStatus [ClusterParameterStatus]

The list of parameter statuses.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

cpgsParameterApplyStatus :: Lens' ClusterParameterGroupStatus (Maybe Text)

The status of parameter updates.

cpgsParameterGroupName :: Lens' ClusterParameterGroupStatus (Maybe Text)

The name of the cluster parameter group.

ClusterParameterStatus

data ClusterParameterStatus

Describes the status of a parameter group.

See: clusterParameterStatus smart constructor.

Instances

Eq ClusterParameterStatus

Data ClusterParameterStatus

Read ClusterParameterStatus

Show ClusterParameterStatus

Generic ClusterParameterStatus

FromXML ClusterParameterStatus

type Rep ClusterParameterStatus

clusterParameterStatus :: ClusterParameterStatus

Creates a value of ClusterParameterStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cpsParameterApplyErrorDescription
• cpsParameterName
• cpsParameterApplyStatus

cpsParameterApplyErrorDescription :: Lens' ClusterParameterStatus (Maybe Text)

The error that prevented the parameter from being applied to the database.

cpsParameterName :: Lens' ClusterParameterStatus (Maybe Text)

The name of the parameter.

cpsParameterApplyStatus :: Lens' ClusterParameterStatus (Maybe Text)

The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

The following are possible statuses and descriptions.

• 'in-sync': The parameter value is in sync with the database.
• 'pending-reboot': The parameter value will be applied after the cluster reboots.
• applying: The parameter value is being applied to the database.
• 'invalid-parameter': Cannot apply the parameter value because it has an invalid value or syntax.
• 'apply-deferred': The parameter contains static property changes. The changes are deferred until the cluster reboots.
• 'apply-error': Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
• 'unknown-error': Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

ClusterSecurityGroup

data ClusterSecurityGroup

Describes a security group.

See: clusterSecurityGroup smart constructor.

Instances

Eq ClusterSecurityGroup

Data ClusterSecurityGroup

Read ClusterSecurityGroup

Show ClusterSecurityGroup

Generic ClusterSecurityGroup

FromXML ClusterSecurityGroup

type Rep ClusterSecurityGroup

clusterSecurityGroup :: ClusterSecurityGroup

Creates a value of ClusterSecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cluClusterSecurityGroupName
• cluIPRanges
• cluEC2SecurityGroups
• cluDescription
• cluTags

cluClusterSecurityGroupName :: Lens' ClusterSecurityGroup (Maybe Text)

The name of the cluster security group to which the operation was applied.

cluIPRanges :: Lens' ClusterSecurityGroup [IPRange]

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

cluEC2SecurityGroups :: Lens' ClusterSecurityGroup [EC2SecurityGroup]

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

cluDescription :: Lens' ClusterSecurityGroup (Maybe Text)

A description of the security group.

cluTags :: Lens' ClusterSecurityGroup [Tag]

The list of tags for the cluster security group.

ClusterSecurityGroupMembership

data ClusterSecurityGroupMembership

Describes a security group.

See: clusterSecurityGroupMembership smart constructor.

Instances

Eq ClusterSecurityGroupMembership

Data ClusterSecurityGroupMembership

Read ClusterSecurityGroupMembership

Show ClusterSecurityGroupMembership

Generic ClusterSecurityGroupMembership

FromXML ClusterSecurityGroupMembership

type Rep ClusterSecurityGroupMembership

clusterSecurityGroupMembership :: ClusterSecurityGroupMembership

Creates a value of ClusterSecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csgmStatus
• csgmClusterSecurityGroupName

csgmStatus :: Lens' ClusterSecurityGroupMembership (Maybe Text)

The status of the cluster security group.

csgmClusterSecurityGroupName :: Lens' ClusterSecurityGroupMembership (Maybe Text)

The name of the cluster security group.

ClusterSnapshotCopyStatus

data ClusterSnapshotCopyStatus

Returns the destination region and retention period that are configured for cross-region snapshot copy.

See: clusterSnapshotCopyStatus smart constructor.

Instances

Eq ClusterSnapshotCopyStatus

Data ClusterSnapshotCopyStatus

Read ClusterSnapshotCopyStatus

Show ClusterSnapshotCopyStatus

Generic ClusterSnapshotCopyStatus

FromXML ClusterSnapshotCopyStatus

type Rep ClusterSnapshotCopyStatus

clusterSnapshotCopyStatus :: ClusterSnapshotCopyStatus

Creates a value of ClusterSnapshotCopyStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cscsRetentionPeriod
• cscsDestinationRegion
• cscsSnapshotCopyGrantName

cscsRetentionPeriod :: Lens' ClusterSnapshotCopyStatus (Maybe Integer)

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

cscsDestinationRegion :: Lens' ClusterSnapshotCopyStatus (Maybe Text)

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

cscsSnapshotCopyGrantName :: Lens' ClusterSnapshotCopyStatus (Maybe Text)

The name of the snapshot copy grant.

ClusterSubnetGroup

data ClusterSubnetGroup

Describes a subnet group.

See: clusterSubnetGroup smart constructor.

Instances

Eq ClusterSubnetGroup

Data ClusterSubnetGroup

Read ClusterSubnetGroup

Show ClusterSubnetGroup

Generic ClusterSubnetGroup

FromXML ClusterSubnetGroup

type Rep ClusterSubnetGroup

clusterSubnetGroup :: ClusterSubnetGroup

Creates a value of ClusterSubnetGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• csgVPCId
• csgSubnets
• csgClusterSubnetGroupName
• csgSubnetGroupStatus
• csgDescription
• csgTags

csgVPCId :: Lens' ClusterSubnetGroup (Maybe Text)

The VPC ID of the cluster subnet group.

csgSubnets :: Lens' ClusterSubnetGroup [Subnet]

A list of the VPC Subnet elements.

csgClusterSubnetGroupName :: Lens' ClusterSubnetGroup (Maybe Text)

The name of the cluster subnet group.

csgSubnetGroupStatus :: Lens' ClusterSubnetGroup (Maybe Text)

The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

csgDescription :: Lens' ClusterSubnetGroup (Maybe Text)

The description of the cluster subnet group.

csgTags :: Lens' ClusterSubnetGroup [Tag]

The list of tags for the cluster subnet group.

ClusterVersion

data ClusterVersion

Describes a cluster version, including the parameter group family and description of the version.

See: clusterVersion smart constructor.

Instances

Eq ClusterVersion

Data ClusterVersion

Read ClusterVersion

Show ClusterVersion

Generic ClusterVersion

FromXML ClusterVersion

type Rep ClusterVersion

clusterVersion :: ClusterVersion

Creates a value of ClusterVersion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cvClusterParameterGroupFamily
• cvClusterVersion
• cvDescription

cvClusterParameterGroupFamily :: Lens' ClusterVersion (Maybe Text)

The name of the cluster parameter group family for the cluster.

cvClusterVersion :: Lens' ClusterVersion (Maybe Text)

The version number used by the cluster.

cvDescription :: Lens' ClusterVersion (Maybe Text)

The description of the cluster version.

DefaultClusterParameters

data DefaultClusterParameters

Describes the default cluster parameters for a parameter group family.

See: defaultClusterParameters smart constructor.

Instances

Eq DefaultClusterParameters

Data DefaultClusterParameters

Read DefaultClusterParameters

Show DefaultClusterParameters

Generic DefaultClusterParameters

FromXML DefaultClusterParameters

type Rep DefaultClusterParameters

defaultClusterParameters :: DefaultClusterParameters

Creates a value of DefaultClusterParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcpMarker
• dcpParameters
• dcpParameterGroupFamily

dcpMarker :: Lens' DefaultClusterParameters (Maybe Text)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

dcpParameters :: Lens' DefaultClusterParameters [Parameter]

The list of cluster default parameters.

dcpParameterGroupFamily :: Lens' DefaultClusterParameters (Maybe Text)

The name of the cluster parameter group family to which the engine default parameters apply.

EC2SecurityGroup

data EC2SecurityGroup

Describes an Amazon EC2 security group.

See: ec2SecurityGroup smart constructor.

Instances

Eq EC2SecurityGroup

Data EC2SecurityGroup

Read EC2SecurityGroup

Show EC2SecurityGroup

Generic EC2SecurityGroup

FromXML EC2SecurityGroup

type Rep EC2SecurityGroup

ec2SecurityGroup :: EC2SecurityGroup

Creates a value of EC2SecurityGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esgStatus
• esgEC2SecurityGroupOwnerId
• esgEC2SecurityGroupName
• esgTags

esgStatus :: Lens' EC2SecurityGroup (Maybe Text)

The status of the EC2 security group.

esgEC2SecurityGroupOwnerId :: Lens' EC2SecurityGroup (Maybe Text)

The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

esgEC2SecurityGroupName :: Lens' EC2SecurityGroup (Maybe Text)

The name of the EC2 Security Group.

esgTags :: Lens' EC2SecurityGroup [Tag]

The list of tags for the EC2 security group.

ElasticIPStatus

data ElasticIPStatus

Describes the status of the elastic IP (EIP) address.

See: elasticIPStatus smart constructor.

Instances

Eq ElasticIPStatus

Data ElasticIPStatus

Read ElasticIPStatus

Show ElasticIPStatus

Generic ElasticIPStatus

FromXML ElasticIPStatus

type Rep ElasticIPStatus

elasticIPStatus :: ElasticIPStatus

Creates a value of ElasticIPStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eisStatus
• eisElasticIP

eisStatus :: Lens' ElasticIPStatus (Maybe Text)

Describes the status of the elastic IP (EIP) address.

eisElasticIP :: Lens' ElasticIPStatus (Maybe Text)

The elastic IP (EIP) address for the cluster.

Endpoint

data Endpoint

Describes a connection endpoint.

See: endpoint smart constructor.

Instances

Eq Endpoint

Data Endpoint

Read Endpoint

Show Endpoint

Generic Endpoint

FromXML Endpoint

type Rep Endpoint

endpoint :: Endpoint

Creates a value of Endpoint with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eAddress
• ePort

eAddress :: Lens' Endpoint (Maybe Text)

The DNS address of the Cluster.

ePort :: Lens' Endpoint (Maybe Int)

The port that the database engine is listening on.

Event

data Event

Describes an event.

See: event smart constructor.

Instances

Eq Event

Data Event

Read Event

Show Event

Generic Event

FromXML Event

type Rep Event

event :: Event

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eSourceType
• eSeverity
• eSourceIdentifier
• eDate
• eEventCategories
• eMessage
• eEventId

eSourceType :: Lens' Event (Maybe SourceType)

The source type for this event.

eSeverity :: Lens' Event (Maybe Text)

The severity of the event.

Values: ERROR, INFO

eSourceIdentifier :: Lens' Event (Maybe Text)

The identifier for the source of the event.

eDate :: Lens' Event (Maybe UTCTime)

The date and time of the event.

eEventCategories :: Lens' Event [Text]

A list of the event categories.

Values: Configuration, Management, Monitoring, Security

eMessage :: Lens' Event (Maybe Text)

The text of this event.

eEventId :: Lens' Event (Maybe Text)

The identifier of the event.

EventCategoriesMap

data EventCategoriesMap

See: eventCategoriesMap smart constructor.

Instances

Eq EventCategoriesMap

Data EventCategoriesMap

Read EventCategoriesMap

Show EventCategoriesMap

Generic EventCategoriesMap

FromXML EventCategoriesMap

type Rep EventCategoriesMap

eventCategoriesMap :: EventCategoriesMap

Creates a value of EventCategoriesMap with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ecmSourceType
• ecmEvents

ecmSourceType :: Lens' EventCategoriesMap (Maybe Text)

The Amazon Redshift source type, such as cluster or cluster-snapshot, that the returned categories belong to.

ecmEvents :: Lens' EventCategoriesMap [EventInfoMap]

The events in the event category.

EventInfoMap

data EventInfoMap

See: eventInfoMap smart constructor.

Instances

Eq EventInfoMap

Data EventInfoMap

Read EventInfoMap

Show EventInfoMap

Generic EventInfoMap

FromXML EventInfoMap

type Rep EventInfoMap

eventInfoMap :: EventInfoMap

Creates a value of EventInfoMap with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eimEventDescription
• eimSeverity
• eimEventCategories
• eimEventId

eimEventDescription :: Lens' EventInfoMap (Maybe Text)

The description of an Amazon Redshift event.

eimSeverity :: Lens' EventInfoMap (Maybe Text)

The severity of the event.

Values: ERROR, INFO

eimEventCategories :: Lens' EventInfoMap [Text]

The category of an Amazon Redshift event.

eimEventId :: Lens' EventInfoMap (Maybe Text)

The identifier of an Amazon Redshift event.

EventSubscription

data EventSubscription

See: eventSubscription smart constructor.

Instances

Eq EventSubscription

Data EventSubscription

Read EventSubscription

Show EventSubscription

Generic EventSubscription

FromXML EventSubscription

type Rep EventSubscription

eventSubscription :: EventSubscription

Creates a value of EventSubscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esStatus
• esCustomerAWSId
• esCustSubscriptionId
• esSNSTopicARN
• esEnabled
• esSourceType
• esSeverity
• esSubscriptionCreationTime
• esEventCategoriesList
• esTags
• esSourceIdsList

esStatus :: Lens' EventSubscription (Maybe Text)

The status of the Amazon Redshift event notification subscription.

Constraints:

• Can be one of the following: active | no-permission | topic-not-exist
• The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

esCustomerAWSId :: Lens' EventSubscription (Maybe Text)

The AWS customer account associated with the Amazon Redshift event notification subscription.

esCustSubscriptionId :: Lens' EventSubscription (Maybe Text)

The name of the Amazon Redshift event notification subscription.

esSNSTopicARN :: Lens' EventSubscription (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

esEnabled :: Lens' EventSubscription (Maybe Bool)

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

esSourceType :: Lens' EventSubscription (Maybe Text)

The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.

esSeverity :: Lens' EventSubscription (Maybe Text)

The event severity specified in the Amazon Redshift event notification subscription.

Values: ERROR, INFO

esSubscriptionCreationTime :: Lens' EventSubscription (Maybe UTCTime)

The date and time the Amazon Redshift event notification subscription was created.

esEventCategoriesList :: Lens' EventSubscription [Text]

The list of Amazon Redshift event categories specified in the event notification subscription.

Values: Configuration, Management, Monitoring, Security

esTags :: Lens' EventSubscription [Tag]

The list of tags for the event subscription.

esSourceIdsList :: Lens' EventSubscription [Text]

A list of the sources that publish events to the Amazon Redshift event notification subscription.

HSMClientCertificate

data HSMClientCertificate

Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

See: hsmClientCertificate smart constructor.

Instances

Eq HSMClientCertificate

Data HSMClientCertificate

Read HSMClientCertificate

Show HSMClientCertificate

Generic HSMClientCertificate

FromXML HSMClientCertificate

type Rep HSMClientCertificate

hsmClientCertificate :: HSMClientCertificate

Creates a value of HSMClientCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hccHSMClientCertificateIdentifier
• hccHSMClientCertificatePublicKey
• hccTags

hccHSMClientCertificateIdentifier :: Lens' HSMClientCertificate (Maybe Text)

The identifier of the HSM client certificate.

hccHSMClientCertificatePublicKey :: Lens' HSMClientCertificate (Maybe Text)

The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

hccTags :: Lens' HSMClientCertificate [Tag]

The list of tags for the HSM client certificate.

HSMConfiguration

data HSMConfiguration

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

See: hsmConfiguration smart constructor.

Instances

Eq HSMConfiguration

Data HSMConfiguration

Read HSMConfiguration

Show HSMConfiguration

Generic HSMConfiguration

FromXML HSMConfiguration

type Rep HSMConfiguration

hsmConfiguration :: HSMConfiguration

Creates a value of HSMConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hcHSMConfigurationIdentifier
• hcHSMPartitionName
• hcDescription
• hcTags
• hcHSMIPAddress

hcHSMConfigurationIdentifier :: Lens' HSMConfiguration (Maybe Text)

The name of the Amazon Redshift HSM configuration.

hcHSMPartitionName :: Lens' HSMConfiguration (Maybe Text)

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

hcDescription :: Lens' HSMConfiguration (Maybe Text)

A text description of the HSM configuration.

hcTags :: Lens' HSMConfiguration [Tag]

The list of tags for the HSM configuration.

hcHSMIPAddress :: Lens' HSMConfiguration (Maybe Text)

The IP address that the Amazon Redshift cluster must use to access the HSM.

HSMStatus

data HSMStatus

See: hsmStatus smart constructor.

Instances

Eq HSMStatus

Data HSMStatus

Read HSMStatus

Show HSMStatus

Generic HSMStatus

FromXML HSMStatus

type Rep HSMStatus

hsmStatus :: HSMStatus

Creates a value of HSMStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• hsStatus
• hsHSMConfigurationIdentifier
• hsHSMClientCertificateIdentifier

hsStatus :: Lens' HSMStatus (Maybe Text)

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Values: active, applying

hsHSMConfigurationIdentifier :: Lens' HSMStatus (Maybe Text)

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

hsHSMClientCertificateIdentifier :: Lens' HSMStatus (Maybe Text)

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

IPRange

data IPRange

Describes an IP range used in a security group.

See: ipRange smart constructor.

Instances

Eq IPRange

Data IPRange

Read IPRange

Show IPRange

Generic IPRange

FromXML IPRange

type Rep IPRange

ipRange :: IPRange

Creates a value of IPRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• irStatus
• irCIdRIP
• irTags

irStatus :: Lens' IPRange (Maybe Text)

The status of the IP range, for example, "authorized".

irCIdRIP :: Lens' IPRange (Maybe Text)

The IP range in Classless Inter-Domain Routing (CIDR) notation.

irTags :: Lens' IPRange [Tag]

The list of tags for the IP range.

LoggingStatus

data LoggingStatus

Describes the status of logging for a cluster.

See: loggingStatus smart constructor.

Instances

Eq LoggingStatus

Data LoggingStatus

Read LoggingStatus

Show LoggingStatus

Generic LoggingStatus

FromXML LoggingStatus

type Rep LoggingStatus

loggingStatus :: LoggingStatus

Creates a value of LoggingStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lsLastFailureTime
• lsLastSuccessfulDeliveryTime
• lsS3KeyPrefix
• lsBucketName
• lsLoggingEnabled
• lsLastFailureMessage

lsLastFailureTime :: Lens' LoggingStatus (Maybe UTCTime)

The last time when logs failed to be delivered.

lsLastSuccessfulDeliveryTime :: Lens' LoggingStatus (Maybe UTCTime)

The last time when logs were delivered.

lsS3KeyPrefix :: Lens' LoggingStatus (Maybe Text)

The prefix applied to the log file names.

lsBucketName :: Lens' LoggingStatus (Maybe Text)

The name of the S3 bucket where the log files are stored.

lsLoggingEnabled :: Lens' LoggingStatus (Maybe Bool)

true if logging is on, false if logging is off.

lsLastFailureMessage :: Lens' LoggingStatus (Maybe Text)

The message indicating that logs failed to be delivered.

OrderableClusterOption

data OrderableClusterOption

Describes an orderable cluster option.

See: orderableClusterOption smart constructor.

Instances

Eq OrderableClusterOption

Data OrderableClusterOption

Read OrderableClusterOption

Show OrderableClusterOption

Generic OrderableClusterOption

FromXML OrderableClusterOption

type Rep OrderableClusterOption

orderableClusterOption :: OrderableClusterOption

Creates a value of OrderableClusterOption with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ocoAvailabilityZones
• ocoClusterType
• ocoClusterVersion
• ocoNodeType

ocoAvailabilityZones :: Lens' OrderableClusterOption [AvailabilityZone]

A list of availability zones for the orderable cluster.

ocoClusterType :: Lens' OrderableClusterOption (Maybe Text)

The cluster type, for example 'multi-node'.

ocoClusterVersion :: Lens' OrderableClusterOption (Maybe Text)

The version of the orderable cluster.

ocoNodeType :: Lens' OrderableClusterOption (Maybe Text)

The node type for the orderable cluster.

Parameter

data Parameter

Describes a parameter in a cluster parameter group.

See: parameter smart constructor.

Instances

Eq Parameter

Data Parameter

Read Parameter

Show Parameter

Generic Parameter

FromXML Parameter

ToQuery Parameter

type Rep Parameter

parameter :: Parameter

Creates a value of Parameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pApplyType
• pParameterValue
• pMinimumEngineVersion
• pSource
• pIsModifiable
• pDataType
• pAllowedValues
• pParameterName
• pDescription

pApplyType :: Lens' Parameter (Maybe ParameterApplyType)

Specifies how to apply the parameter. Supported value: static.

pParameterValue :: Lens' Parameter (Maybe Text)

The value of the parameter.

pMinimumEngineVersion :: Lens' Parameter (Maybe Text)

The earliest engine version to which the parameter can apply.

pSource :: Lens' Parameter (Maybe Text)

The source of the parameter value, such as "engine-default" or "user".

pIsModifiable :: Lens' Parameter (Maybe Bool)

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

pDataType :: Lens' Parameter (Maybe Text)

The data type of the parameter.

pAllowedValues :: Lens' Parameter (Maybe Text)

The valid range of values for the parameter.

pParameterName :: Lens' Parameter (Maybe Text)

The name of the parameter.

pDescription :: Lens' Parameter (Maybe Text)

A description of the parameter.

PendingModifiedValues

data PendingModifiedValues

Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.

See: pendingModifiedValues smart constructor.

Instances

Eq PendingModifiedValues

Data PendingModifiedValues

Read PendingModifiedValues

Show PendingModifiedValues

Generic PendingModifiedValues

FromXML PendingModifiedValues

type Rep PendingModifiedValues

pendingModifiedValues :: PendingModifiedValues

Creates a value of PendingModifiedValues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pmvMasterUserPassword
• pmvAutomatedSnapshotRetentionPeriod
• pmvClusterIdentifier
• pmvNumberOfNodes
• pmvClusterType
• pmvClusterVersion
• pmvNodeType

pmvMasterUserPassword :: Lens' PendingModifiedValues (Maybe Text)

The pending or in-progress change of the master user password for the cluster.

pmvAutomatedSnapshotRetentionPeriod :: Lens' PendingModifiedValues (Maybe Int)

The pending or in-progress change of the automated snapshot retention period.

pmvClusterIdentifier :: Lens' PendingModifiedValues (Maybe Text)

The pending or in-progress change of the new identifier for the cluster.

pmvNumberOfNodes :: Lens' PendingModifiedValues (Maybe Int)

The pending or in-progress change of the number of nodes in the cluster.

pmvClusterType :: Lens' PendingModifiedValues (Maybe Text)

The pending or in-progress change of the cluster type.

pmvClusterVersion :: Lens' PendingModifiedValues (Maybe Text)

The pending or in-progress change of the service version.

pmvNodeType :: Lens' PendingModifiedValues (Maybe Text)

The pending or in-progress change of the cluster's node type.

RecurringCharge

data RecurringCharge

Describes a recurring charge.

See: recurringCharge smart constructor.

Instances

Eq RecurringCharge

Data RecurringCharge

Read RecurringCharge

Show RecurringCharge

Generic RecurringCharge

FromXML RecurringCharge

type Rep RecurringCharge

recurringCharge :: RecurringCharge

Creates a value of RecurringCharge with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rcRecurringChargeFrequency
• rcRecurringChargeAmount

rcRecurringChargeFrequency :: Lens' RecurringCharge (Maybe Text)

The frequency at which the recurring charge amount is applied.

rcRecurringChargeAmount :: Lens' RecurringCharge (Maybe Double)

The amount charged per the period of time specified by the recurring charge frequency.

ReservedNode

data ReservedNode

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

See: reservedNode smart constructor.

Instances

Eq ReservedNode

Data ReservedNode

Read ReservedNode

Show ReservedNode

Generic ReservedNode

FromXML ReservedNode

type Rep ReservedNode

reservedNode :: ReservedNode

Creates a value of ReservedNode with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rnState
• rnCurrencyCode
• rnStartTime
• rnNodeCount
• rnReservedNodeId
• rnReservedNodeOfferingId
• rnRecurringCharges
• rnOfferingType
• rnUsagePrice
• rnNodeType
• rnFixedPrice
• rnDuration

rnState :: Lens' ReservedNode (Maybe Text)

The state of the reserved compute node.

Possible Values:

• pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
• active-This reserved node is owned by the caller and is available for use.
• payment-failed-Payment failed for the purchase attempt.

rnCurrencyCode :: Lens' ReservedNode (Maybe Text)

The currency code for the reserved cluster.

rnStartTime :: Lens' ReservedNode (Maybe UTCTime)

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

rnNodeCount :: Lens' ReservedNode (Maybe Int)

The number of reserved compute nodes.

rnReservedNodeId :: Lens' ReservedNode (Maybe Text)

The unique identifier for the reservation.

rnReservedNodeOfferingId :: Lens' ReservedNode (Maybe Text)

The identifier for the reserved node offering.

rnRecurringCharges :: Lens' ReservedNode [RecurringCharge]

The recurring charges for the reserved node.

rnOfferingType :: Lens' ReservedNode (Maybe Text)

The anticipated utilization of the reserved node, as defined in the reserved node offering.

rnUsagePrice :: Lens' ReservedNode (Maybe Double)

The hourly rate Amazon Redshift charges you for this reserved node.

rnNodeType :: Lens' ReservedNode (Maybe Text)

The node type of the reserved node.

rnFixedPrice :: Lens' ReservedNode (Maybe Double)

The fixed cost Amazon Redshift charges you for this reserved node.

rnDuration :: Lens' ReservedNode (Maybe Int)

The duration of the node reservation in seconds.

ReservedNodeOffering

data ReservedNodeOffering

Describes a reserved node offering.

See: reservedNodeOffering smart constructor.

Instances

Eq ReservedNodeOffering

Data ReservedNodeOffering

Read ReservedNodeOffering

Show ReservedNodeOffering

Generic ReservedNodeOffering

FromXML ReservedNodeOffering

type Rep ReservedNodeOffering

reservedNodeOffering :: ReservedNodeOffering

Creates a value of ReservedNodeOffering with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rnoCurrencyCode
• rnoReservedNodeOfferingId
• rnoRecurringCharges
• rnoOfferingType
• rnoUsagePrice
• rnoNodeType
• rnoFixedPrice
• rnoDuration

rnoCurrencyCode :: Lens' ReservedNodeOffering (Maybe Text)

The currency code for the compute nodes offering.

rnoReservedNodeOfferingId :: Lens' ReservedNodeOffering (Maybe Text)

The offering identifier.

rnoRecurringCharges :: Lens' ReservedNodeOffering [RecurringCharge]

The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

rnoOfferingType :: Lens' ReservedNodeOffering (Maybe Text)

The anticipated utilization of the reserved node, as defined in the reserved node offering.

rnoUsagePrice :: Lens' ReservedNodeOffering (Maybe Double)

The rate you are charged for each hour the cluster that is using the offering is running.

rnoNodeType :: Lens' ReservedNodeOffering (Maybe Text)

The node type offered by the reserved node offering.

rnoFixedPrice :: Lens' ReservedNodeOffering (Maybe Double)

The upfront fixed charge you will pay to purchase the specific reserved node offering.

rnoDuration :: Lens' ReservedNodeOffering (Maybe Int)

The duration, in seconds, for which the offering will reserve the node.

RestoreStatus

data RestoreStatus

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

See: restoreStatus smart constructor.

Instances

Eq RestoreStatus

Data RestoreStatus

Read RestoreStatus

Show RestoreStatus

Generic RestoreStatus

FromXML RestoreStatus

type Rep RestoreStatus

restoreStatus :: RestoreStatus

Creates a value of RestoreStatus with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rsStatus
• rsEstimatedTimeToCompletionInSeconds
• rsCurrentRestoreRateInMegaBytesPerSecond
• rsProgressInMegaBytes
• rsElapsedTimeInSeconds
• rsSnapshotSizeInMegaBytes

rsStatus :: Lens' RestoreStatus (Maybe Text)

The status of the restore action. Returns starting, restoring, completed, or failed.

rsEstimatedTimeToCompletionInSeconds :: Lens' RestoreStatus (Maybe Integer)

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

rsCurrentRestoreRateInMegaBytesPerSecond :: Lens' RestoreStatus (Maybe Double)

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

rsProgressInMegaBytes :: Lens' RestoreStatus (Maybe Integer)

The number of megabytes that have been transferred from snapshot storage.

rsElapsedTimeInSeconds :: Lens' RestoreStatus (Maybe Integer)

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

rsSnapshotSizeInMegaBytes :: Lens' RestoreStatus (Maybe Integer)

The size of the set of snapshot data used to restore the cluster.

Snapshot

data Snapshot

Describes a snapshot.

See: snapshot smart constructor.

Instances

Eq Snapshot

Data Snapshot

Read Snapshot

Show Snapshot

Generic Snapshot

FromXML Snapshot

type Rep Snapshot

snapshot :: Snapshot

Creates a value of Snapshot with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sStatus
• sRestorableNodeTypes
• sAccountsWithRestoreAccess
• sSnapshotIdentifier
• sEncryptedWithHSM
• sMasterUsername
• sSourceRegion
• sVPCId
• sBackupProgressInMegaBytes
• sEncrypted
• sClusterIdentifier
• sNumberOfNodes
• sSnapshotType
• sKMSKeyId
• sAvailabilityZone
• sCurrentBackupRateInMegaBytesPerSecond
• sSnapshotCreateTime
• sClusterVersion
• sOwnerAccount
• sNodeType
• sElapsedTimeInSeconds
• sClusterCreateTime
• sEstimatedSecondsToCompletion
• sActualIncrementalBackupSizeInMegaBytes
• sTags
• sPort
• sTotalBackupSizeInMegaBytes
• sDBName

sStatus :: Lens' Snapshot (Maybe Text)

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

sRestorableNodeTypes :: Lens' Snapshot [Text]

The list of node types that this cluster snapshot is able to restore into.

sAccountsWithRestoreAccess :: Lens' Snapshot [AccountWithRestoreAccess]

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

sSnapshotIdentifier :: Lens' Snapshot (Maybe Text)

The snapshot identifier that is provided in the request.

sEncryptedWithHSM :: Lens' Snapshot (Maybe Bool)

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

sMasterUsername :: Lens' Snapshot (Maybe Text)

The master user name for the cluster.

sSourceRegion :: Lens' Snapshot (Maybe Text)

The source region from which the snapshot was copied.

sVPCId :: Lens' Snapshot (Maybe Text)

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

sBackupProgressInMegaBytes :: Lens' Snapshot (Maybe Double)

The number of megabytes that have been transferred to the snapshot backup.

sEncrypted :: Lens' Snapshot (Maybe Bool)

If true, the data in the snapshot is encrypted at rest.

sClusterIdentifier :: Lens' Snapshot (Maybe Text)

The identifier of the cluster for which the snapshot was taken.

sNumberOfNodes :: Lens' Snapshot (Maybe Int)

The number of nodes in the cluster.

sSnapshotType :: Lens' Snapshot (Maybe Text)

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

sKMSKeyId :: Lens' Snapshot (Maybe Text)

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

sAvailabilityZone :: Lens' Snapshot (Maybe Text)

The Availability Zone in which the cluster was created.

sCurrentBackupRateInMegaBytesPerSecond :: Lens' Snapshot (Maybe Double)

The number of megabytes per second being transferred to the snapshot backup. Returns '0' for a completed backup.

sSnapshotCreateTime :: Lens' Snapshot (Maybe UTCTime)

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

sClusterVersion :: Lens' Snapshot (Maybe Text)

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

sOwnerAccount :: Lens' Snapshot (Maybe Text)

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

sNodeType :: Lens' Snapshot (Maybe Text)

The node type of the nodes in the cluster.

sElapsedTimeInSeconds :: Lens' Snapshot (Maybe Integer)

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

sClusterCreateTime :: Lens' Snapshot (Maybe UTCTime)

The time (UTC) when the cluster was originally created.

sEstimatedSecondsToCompletion :: Lens' Snapshot (Maybe Integer)

The estimate of the time remaining before the snapshot backup will complete. Returns '0' for a completed backup.

sActualIncrementalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double)

The size of the incremental backup.

sTags :: Lens' Snapshot [Tag]

The list of tags for the cluster snapshot.

sPort :: Lens' Snapshot (Maybe Int)

The port that the cluster is listening on.

sTotalBackupSizeInMegaBytes :: Lens' Snapshot (Maybe Double)

The size of the complete set of backup data that would be used to restore the cluster.

sDBName :: Lens' Snapshot (Maybe Text)

The name of the database that was created when the cluster was created.

SnapshotCopyGrant

data SnapshotCopyGrant

The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

See: snapshotCopyGrant smart constructor.

Instances

Eq SnapshotCopyGrant

Data SnapshotCopyGrant

Read SnapshotCopyGrant

Show SnapshotCopyGrant

Generic SnapshotCopyGrant

FromXML SnapshotCopyGrant

type Rep SnapshotCopyGrant

snapshotCopyGrant :: SnapshotCopyGrant

Creates a value of SnapshotCopyGrant with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• scgKMSKeyId
• scgSnapshotCopyGrantName
• scgTags

scgKMSKeyId :: Lens' SnapshotCopyGrant (Maybe Text)

The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.

scgSnapshotCopyGrantName :: Lens' SnapshotCopyGrant (Maybe Text)

The name of the snapshot copy grant.

scgTags :: Lens' SnapshotCopyGrant [Tag]

A list of tag instances.

Subnet

data Subnet

Describes a subnet.

See: subnet smart constructor.

Instances

Eq Subnet

Data Subnet

Read Subnet

Show Subnet

Generic Subnet

FromXML Subnet

type Rep Subnet

subnet :: Subnet

Creates a value of Subnet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sSubnetStatus
• sSubnetIdentifier
• sSubnetAvailabilityZone

sSubnetStatus :: Lens' Subnet (Maybe Text)

The status of the subnet.

sSubnetIdentifier :: Lens' Subnet (Maybe Text)

The identifier of the subnet.

sSubnetAvailabilityZone :: Lens' Subnet (Maybe AvailabilityZone)

Undocumented member.

Tag

data Tag

A tag consisting of a name/value pair for a resource.

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

FromXML Tag

ToQuery Tag

type Rep Tag

tag :: Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagValue
• tagKey

tagValue :: Lens' Tag (Maybe Text)

The value for the resource tag.

tagKey :: Lens' Tag (Maybe Text)

The key, or name, for the resource tag.

TaggedResource

data TaggedResource

A tag and its associated resource.

See: taggedResource smart constructor.

Instances

Eq TaggedResource

Data TaggedResource

Read TaggedResource

Show TaggedResource

Generic TaggedResource

FromXML TaggedResource

type Rep TaggedResource

taggedResource :: TaggedResource

Creates a value of TaggedResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• trTag
• trResourceType
• trResourceName

trTag :: Lens' TaggedResource (Maybe Tag)

The tag for the resource.

trResourceType :: Lens' TaggedResource (Maybe Text)

The type of resource with which the tag is associated. Valid resource types are:

• Cluster
• CIDR/IP
• EC2 security group
• Snapshot
• Cluster security group
• Subnet group
• HSM connection
• HSM certificate
• Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

trResourceName :: Lens' TaggedResource (Maybe Text)

The Amazon Resource Name (ARN) with which the tag is associated. For example, 'arn:aws:redshift:us-east-1:123456789:cluster:t1'.

VPCSecurityGroupMembership

data VPCSecurityGroupMembership

Describes the members of a VPC security group.

See: vpcSecurityGroupMembership smart constructor.

Instances

Eq VPCSecurityGroupMembership

Data VPCSecurityGroupMembership

Read VPCSecurityGroupMembership

Show VPCSecurityGroupMembership

Generic VPCSecurityGroupMembership

FromXML VPCSecurityGroupMembership

type Rep VPCSecurityGroupMembership

vpcSecurityGroupMembership :: VPCSecurityGroupMembership

Creates a value of VPCSecurityGroupMembership with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vsgmStatus
• vsgmVPCSecurityGroupId

vsgmStatus :: Lens' VPCSecurityGroupMembership (Maybe Text)

Undocumented member.

vsgmVPCSecurityGroupId :: Lens' VPCSecurityGroupMembership (Maybe Text)

Undocumented member.