# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Redshift module Types # @note When making an API call, you may pass AcceptReservedNodeExchangeInputMessage # data as a hash: # # { # reserved_node_id: "String", # required # target_reserved_node_offering_id: "String", # required # } # # @!attribute [rw] reserved_node_id # A string representing the node identifier of the DC1 Reserved Node # to be exchanged. # @return [String] # # @!attribute [rw] target_reserved_node_offering_id # The unique identifier of the DC2 Reserved Node offering to be used # for the exchange. You can obtain the value for the parameter by # calling GetReservedNodeExchangeOfferings # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AcceptReservedNodeExchangeInputMessage AWS API Documentation # class AcceptReservedNodeExchangeInputMessage < Struct.new( :reserved_node_id, :target_reserved_node_offering_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] exchanged_reserved_node # @return [Types::ReservedNode] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AcceptReservedNodeExchangeOutputMessage AWS API Documentation # class AcceptReservedNodeExchangeOutputMessage < Struct.new( :exchanged_reserved_node) SENSITIVE = [] include Aws::Structure end # You are not authorized to access the cluster. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AccessToClusterDeniedFault AWS API Documentation # class AccessToClusterDeniedFault < Aws::EmptyStructure; end # The owner of the specified snapshot has not authorized your account to # access the snapshot. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AccessToSnapshotDeniedFault AWS API Documentation # class AccessToSnapshotDeniedFault < Aws::EmptyStructure; end # A name value pair that describes an aspect of an account. # # @!attribute [rw] attribute_name # The name of the attribute. # @return [String] # # @!attribute [rw] attribute_values # A list of attribute values. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AccountAttribute AWS API Documentation # class AccountAttribute < Struct.new( :attribute_name, :attribute_values) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] account_attributes # A list of attributes assigned to an account. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AccountAttributeList AWS API Documentation # class AccountAttributeList < Struct.new( :account_attributes) SENSITIVE = [] include Aws::Structure end # Describes an Amazon Web Services account authorized to restore a # snapshot. # # @!attribute [rw] account_id # The identifier of an Amazon Web Services account authorized to # restore a snapshot. # @return [String] # # @!attribute [rw] account_alias # The identifier of an Amazon Web Services support account authorized # to restore a snapshot. For Amazon Web Services Support, the # identifier is `amazon-redshift-support`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AccountWithRestoreAccess AWS API Documentation # class AccountWithRestoreAccess < Struct.new( :account_id, :account_alias) SENSITIVE = [] include Aws::Structure end # The AQUA (Advanced Query Accelerator) configuration of the cluster. # # @!attribute [rw] aqua_status # The value indicates the status of AQUA on the cluster. Possible # values include the following. # # * enabled - AQUA is enabled. # # * disabled - AQUA is not enabled. # # * applying - AQUA status is being applied. # @return [String] # # @!attribute [rw] aqua_configuration_status # The value represents how the cluster is configured to use AQUA. # Possible values include the following. # # * enabled - Use AQUA if it is available for the current Amazon Web # Services Region and Amazon Redshift node type. # # * disabled - Don't use AQUA. # # * auto - Amazon Redshift determines whether to use AQUA. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AquaConfiguration AWS API Documentation # class AquaConfiguration < Struct.new( :aqua_status, :aqua_configuration_status) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AssociateDataShareConsumerMessage # data as a hash: # # { # data_share_arn: "String", # required # associate_entire_account: false, # consumer_arn: "String", # consumer_region: "String", # } # # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare that the consumer is # to use with the account or the namespace. # @return [String] # # @!attribute [rw] associate_entire_account # A value that specifies whether the datashare is associated with the # entire account. # @return [Boolean] # # @!attribute [rw] consumer_arn # The Amazon Resource Name (ARN) of the consumer that is associated # with the datashare. # @return [String] # # @!attribute [rw] consumer_region # From a datashare consumer account, associates a datashare with all # existing and future namespaces in the specified Amazon Web Services # Region. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AssociateDataShareConsumerMessage AWS API Documentation # class AssociateDataShareConsumerMessage < Struct.new( :data_share_arn, :associate_entire_account, :consumer_arn, :consumer_region) SENSITIVE = [] include Aws::Structure end # Describes an attribute value. # # @!attribute [rw] attribute_value # The value of the attribute. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AttributeValueTarget AWS API Documentation # class AttributeValueTarget < Struct.new( :attribute_value) SENSITIVE = [] include Aws::Structure end # Describes an authentication profile. # # @!attribute [rw] authentication_profile_name # The name of the authentication profile. # @return [String] # # @!attribute [rw] authentication_profile_content # The content of the authentication profile in JSON format. The # maximum length of the JSON string is determined by a quota for your # account. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthenticationProfile AWS API Documentation # class AuthenticationProfile < Struct.new( :authentication_profile_name, :authentication_profile_content) SENSITIVE = [] include Aws::Structure end # The authentication profile already exists. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthenticationProfileAlreadyExistsFault AWS API Documentation # class AuthenticationProfileAlreadyExistsFault < Aws::EmptyStructure; end # The authentication profile can't be found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthenticationProfileNotFoundFault AWS API Documentation # class AuthenticationProfileNotFoundFault < Aws::EmptyStructure; end # The size or number of authentication profiles has exceeded the quota. # The maximum length of the JSON string and maximum number of # authentication profiles is determined by a quota for your account. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthenticationProfileQuotaExceededFault AWS API Documentation # class AuthenticationProfileQuotaExceededFault < Aws::EmptyStructure; end # The specified CIDR block or EC2 security group is already authorized # for the specified cluster security group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizationAlreadyExistsFault AWS API Documentation # class AuthorizationAlreadyExistsFault < Aws::EmptyStructure; end # The specified CIDR IP range or EC2 security group is not authorized # for the specified cluster security group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizationNotFoundFault AWS API Documentation # class AuthorizationNotFoundFault < Aws::EmptyStructure; end # The authorization quota for the cluster security group has been # reached. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizationQuotaExceededFault AWS API Documentation # class AuthorizationQuotaExceededFault < Aws::EmptyStructure; end # @note When making an API call, you may pass AuthorizeClusterSecurityGroupIngressMessage # data as a hash: # # { # cluster_security_group_name: "String", # required # cidrip: "String", # ec2_security_group_name: "String", # ec2_security_group_owner_id: "String", # } # # @!attribute [rw] cluster_security_group_name # The name of the security group to which the ingress rule is added. # @return [String] # # @!attribute [rw] cidrip # The IP range to be added the Amazon Redshift security group. # @return [String] # # @!attribute [rw] ec2_security_group_name # The EC2 security group to be added the Amazon Redshift security # group. # @return [String] # # @!attribute [rw] ec2_security_group_owner_id # The Amazon Web Services account number of the owner of the security # group specified by the *EC2SecurityGroupName* parameter. The Amazon # Web Services Access Key ID is not an acceptable value. # # Example: `111122223333` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeClusterSecurityGroupIngressMessage AWS API Documentation # class AuthorizeClusterSecurityGroupIngressMessage < Struct.new( :cluster_security_group_name, :cidrip, :ec2_security_group_name, :ec2_security_group_owner_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_security_group # Describes a security group. # @return [Types::ClusterSecurityGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeClusterSecurityGroupIngressResult AWS API Documentation # class AuthorizeClusterSecurityGroupIngressResult < Struct.new( :cluster_security_group) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AuthorizeDataShareMessage # data as a hash: # # { # data_share_arn: "String", # required # consumer_identifier: "String", # required # } # # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare that producers are # to authorize sharing for. # @return [String] # # @!attribute [rw] consumer_identifier # The identifier of the data consumer that is authorized to access the # datashare. This identifier is an Amazon Web Services account ID or a # keyword, such as ADX. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeDataShareMessage AWS API Documentation # class AuthorizeDataShareMessage < Struct.new( :data_share_arn, :consumer_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AuthorizeEndpointAccessMessage # data as a hash: # # { # cluster_identifier: "String", # account: "String", # required # vpc_ids: ["String"], # } # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster to grant access to. # @return [String] # # @!attribute [rw] account # The Amazon Web Services account ID to grant access to. # @return [String] # # @!attribute [rw] vpc_ids # The virtual private cloud (VPC) identifiers to grant access to. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeEndpointAccessMessage AWS API Documentation # class AuthorizeEndpointAccessMessage < Struct.new( :cluster_identifier, :account, :vpc_ids) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass AuthorizeSnapshotAccessMessage # data as a hash: # # { # snapshot_identifier: "String", # required # snapshot_cluster_identifier: "String", # account_with_restore_access: "String", # required # } # # @!attribute [rw] snapshot_identifier # The identifier of the snapshot the account is authorized to restore. # @return [String] # # @!attribute [rw] snapshot_cluster_identifier # The identifier of the cluster the snapshot was created from. This # parameter is required if your IAM user has a policy containing a # snapshot resource element that specifies anything other than * for # the cluster name. # @return [String] # # @!attribute [rw] account_with_restore_access # The identifier of the Amazon Web Services account authorized to # restore the specified snapshot. # # To share a snapshot with Amazon Web Services Support, specify # amazon-redshift-support. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeSnapshotAccessMessage AWS API Documentation # class AuthorizeSnapshotAccessMessage < Struct.new( :snapshot_identifier, :snapshot_cluster_identifier, :account_with_restore_access) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeSnapshotAccessResult AWS API Documentation # class AuthorizeSnapshotAccessResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # Describes an availability zone. # # @!attribute [rw] name # The name of the availability zone. # @return [String] # # @!attribute [rw] supported_platforms # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AvailabilityZone AWS API Documentation # class AvailabilityZone < Struct.new( :name, :supported_platforms) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass BatchDeleteClusterSnapshotsRequest # data as a hash: # # { # identifiers: [ # required # { # snapshot_identifier: "String", # required # snapshot_cluster_identifier: "String", # }, # ], # } # # @!attribute [rw] identifiers # A list of identifiers for the snapshots that you want to delete. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchDeleteClusterSnapshotsRequest AWS API Documentation # class BatchDeleteClusterSnapshotsRequest < Struct.new( :identifiers) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resources # A list of the snapshot identifiers that were deleted. # @return [Array] # # @!attribute [rw] errors # A list of any errors returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchDeleteClusterSnapshotsResult AWS API Documentation # class BatchDeleteClusterSnapshotsResult < Struct.new( :resources, :errors) SENSITIVE = [] include Aws::Structure end # The maximum number for a batch delete of snapshots has been reached. # The limit is 100. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchDeleteRequestSizeExceededFault AWS API Documentation # class BatchDeleteRequestSizeExceededFault < Aws::EmptyStructure; end # The maximum number for snapshot identifiers has been reached. The # limit is 100. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchModifyClusterSnapshotsLimitExceededFault AWS API Documentation # class BatchModifyClusterSnapshotsLimitExceededFault < Aws::EmptyStructure; end # @note When making an API call, you may pass BatchModifyClusterSnapshotsMessage # data as a hash: # # { # snapshot_identifier_list: ["String"], # required # manual_snapshot_retention_period: 1, # force: false, # } # # @!attribute [rw] snapshot_identifier_list # A list of snapshot identifiers you want to modify. # @return [Array] # # @!attribute [rw] manual_snapshot_retention_period # The number of days that a manual snapshot is retained. If you # specify the value -1, the manual snapshot is retained indefinitely. # # The number must be either -1 or an integer between 1 and 3,653. # # If you decrease the manual snapshot retention period from its # current value, existing manual snapshots that fall outside of the # new retention period will return an error. If you want to suppress # the errors and delete the snapshots, use the force option. # @return [Integer] # # @!attribute [rw] force # A boolean value indicating whether to override an exception if the # retention period has passed. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchModifyClusterSnapshotsMessage AWS API Documentation # class BatchModifyClusterSnapshotsMessage < Struct.new( :snapshot_identifier_list, :manual_snapshot_retention_period, :force) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resources # A list of the snapshots that were modified. # @return [Array] # # @!attribute [rw] errors # A list of any errors returned. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BatchModifyClusterSnapshotsOutputMessage AWS API Documentation # class BatchModifyClusterSnapshotsOutputMessage < Struct.new( :resources, :errors) SENSITIVE = [] include Aws::Structure end # Could not find the specified S3 bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/BucketNotFoundFault AWS API Documentation # class BucketNotFoundFault < Aws::EmptyStructure; end # @note When making an API call, you may pass CancelResizeMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The unique identifier for the cluster that you want to cancel a # resize operation for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CancelResizeMessage AWS API Documentation # class CancelResizeMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # Describes a cluster. # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster. # @return [String] # # @!attribute [rw] node_type # The node type for the nodes in the cluster. # @return [String] # # @!attribute [rw] cluster_status # 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` # @return [String] # # @!attribute [rw] cluster_availability_status # 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. # @return [String] # # @!attribute [rw] modify_status # The status of a modify operation, if any, initiated for the cluster. # @return [String] # # @!attribute [rw] master_username # The admin user name for the cluster. This name is used to connect to # the database that is specified in the **DBName** parameter. # @return [String] # # @!attribute [rw] db_name # 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`dev # was created by default. # @return [String] # # @!attribute [rw] endpoint # The connection endpoint. # @return [Types::Endpoint] # # @!attribute [rw] cluster_create_time # The date and time that the cluster was created. # @return [Time] # # @!attribute [rw] automated_snapshot_retention_period # The number of days that automatic cluster snapshots are retained. # @return [Integer] # # @!attribute [rw] manual_snapshot_retention_period # 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. # @return [Integer] # # @!attribute [rw] cluster_security_groups # 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. # @return [Array] # # @!attribute [rw] vpc_security_groups # 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. # @return [Array] # # @!attribute [rw] cluster_parameter_groups # The list of cluster parameter groups that are associated with this # cluster. Each parameter group in the list is returned with its # status. # @return [Array] # # @!attribute [rw] cluster_subnet_group_name # The name of the subnet group that is associated with the cluster. # This parameter is valid only when the cluster is in a VPC. # @return [String] # # @!attribute [rw] vpc_id # The identifier of the VPC the cluster is in, if the cluster is in a # VPC. # @return [String] # # @!attribute [rw] availability_zone # The name of the Availability Zone in which the cluster is located. # @return [String] # # @!attribute [rw] preferred_maintenance_window # The weekly time range, in Universal Coordinated Time (UTC), during # which system maintenance can occur. # @return [String] # # @!attribute [rw] pending_modified_values # A value that, if present, indicates that changes to the cluster are # pending. Specific pending changes are identified by subelements. # @return [Types::PendingModifiedValues] # # @!attribute [rw] cluster_version # The version ID of the Amazon Redshift engine that is running on the # cluster. # @return [String] # # @!attribute [rw] allow_version_upgrade # A boolean value that, if `true`, indicates that major version # upgrades will be applied automatically to the cluster during the # maintenance window. # @return [Boolean] # # @!attribute [rw] number_of_nodes # The number of compute nodes in the cluster. # @return [Integer] # # @!attribute [rw] publicly_accessible # A boolean value that, if `true`, indicates that the cluster can be # accessed from a public network. # @return [Boolean] # # @!attribute [rw] encrypted # A boolean value that, if `true`, indicates that data in the cluster # is encrypted at rest. # @return [Boolean] # # @!attribute [rw] restore_status # 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. # @return [Types::RestoreStatus] # # @!attribute [rw] data_transfer_progress # @return [Types::DataTransferProgress] # # @!attribute [rw] hsm_status # 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 # @return [Types::HsmStatus] # # @!attribute [rw] cluster_snapshot_copy_status # A value that returns the destination region and retention period # that are configured for cross-region snapshot copy. # @return [Types::ClusterSnapshotCopyStatus] # # @!attribute [rw] cluster_public_key # The public key for the cluster. # @return [String] # # @!attribute [rw] cluster_nodes # The nodes in the cluster. # @return [Array] # # @!attribute [rw] elastic_ip_status # The status of the elastic IP (EIP) address. # @return [Types::ElasticIpStatus] # # @!attribute [rw] cluster_revision_number # The specific revision number of the database in the cluster. # @return [String] # # @!attribute [rw] tags # The list of tags for the cluster. # @return [Array] # # @!attribute [rw] kms_key_id # The Key Management Service (KMS) key ID of the encryption key used # to encrypt data in the cluster. # @return [String] # # @!attribute [rw] enhanced_vpc_routing # 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][1] in the Amazon Redshift Cluster Management # Guide. # # If this option is `true`, enhanced VPC routing is enabled. # # Default: false # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html # @return [Boolean] # # @!attribute [rw] iam_roles # A list of Identity and Access Management (IAM) roles that can be # used by the cluster to access other Amazon Web Services services. # @return [Array] # # @!attribute [rw] pending_actions # Cluster operations that are waiting to be started. # @return [Array] # # @!attribute [rw] maintenance_track_name # The name of the maintenance track for the cluster. # @return [String] # # @!attribute [rw] elastic_resize_number_of_node_options # The number of nodes that you can resize the cluster to with the # elastic resize method. # @return [String] # # @!attribute [rw] deferred_maintenance_windows # Describes a group of `DeferredMaintenanceWindow` objects. # @return [Array] # # @!attribute [rw] snapshot_schedule_identifier # A unique identifier for the cluster snapshot schedule. # @return [String] # # @!attribute [rw] snapshot_schedule_state # The current state of the cluster snapshot schedule. # @return [String] # # @!attribute [rw] expected_next_snapshot_schedule_time # The date and time when the next snapshot is expected to be taken for # clusters with a valid snapshot schedule and backups enabled. # @return [Time] # # @!attribute [rw] expected_next_snapshot_schedule_time_status # 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. # @return [String] # # @!attribute [rw] next_maintenance_window_start_time # The date and time in UTC when system maintenance can begin. # @return [Time] # # @!attribute [rw] resize_info # Returns the following: # # * AllowCancelResize: a boolean value indicating if the resize # operation can be cancelled. # # * ResizeType: Returns ClassicResize # @return [Types::ResizeInfo] # # @!attribute [rw] availability_zone_relocation_status # Describes the status of the Availability Zone relocation operation. # @return [String] # # @!attribute [rw] cluster_namespace_arn # The namespace Amazon Resource Name (ARN) of the cluster. # @return [String] # # @!attribute [rw] total_storage_capacity_in_mega_bytes # The total storage capacity of the cluster in megabytes. # @return [Integer] # # @!attribute [rw] aqua_configuration # The AQUA (Advanced Query Accelerator) configuration of the cluster. # @return [Types::AquaConfiguration] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) for the IAM role set as default for # the cluster. # @return [String] # # @!attribute [rw] reserved_node_exchange_status # The status of the reserved-node exchange request. Statuses include # in-progress and requested. # @return [Types::ReservedNodeExchangeStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Cluster AWS API Documentation # class Cluster < Struct.new( :cluster_identifier, :node_type, :cluster_status, :cluster_availability_status, :modify_status, :master_username, :db_name, :endpoint, :cluster_create_time, :automated_snapshot_retention_period, :manual_snapshot_retention_period, :cluster_security_groups, :vpc_security_groups, :cluster_parameter_groups, :cluster_subnet_group_name, :vpc_id, :availability_zone, :preferred_maintenance_window, :pending_modified_values, :cluster_version, :allow_version_upgrade, :number_of_nodes, :publicly_accessible, :encrypted, :restore_status, :data_transfer_progress, :hsm_status, :cluster_snapshot_copy_status, :cluster_public_key, :cluster_nodes, :elastic_ip_status, :cluster_revision_number, :tags, :kms_key_id, :enhanced_vpc_routing, :iam_roles, :pending_actions, :maintenance_track_name, :elastic_resize_number_of_node_options, :deferred_maintenance_windows, :snapshot_schedule_identifier, :snapshot_schedule_state, :expected_next_snapshot_schedule_time, :expected_next_snapshot_schedule_time_status, :next_maintenance_window_start_time, :resize_info, :availability_zone_relocation_status, :cluster_namespace_arn, :total_storage_capacity_in_mega_bytes, :aqua_configuration, :default_iam_role_arn, :reserved_node_exchange_status) SENSITIVE = [] include Aws::Structure end # The account already has a cluster with the given identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterAlreadyExistsFault AWS API Documentation # class ClusterAlreadyExistsFault < Aws::EmptyStructure; end # @!attribute [rw] cluster_identifier # @return [String] # # @!attribute [rw] schedule_association_state # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterAssociatedToSchedule AWS API Documentation # class ClusterAssociatedToSchedule < Struct.new( :cluster_identifier, :schedule_association_state) SENSITIVE = [] include Aws::Structure end # Temporary credentials with authorization to log on to an Amazon # Redshift database. # # @!attribute [rw] db_user # A database user name that is authorized to log on to the database # `DbName` using the password `DbPassword`. If the specified DbUser # exists in the database, the new user name has the same database # permissions as the the user named in DbUser. By default, the user is # added to PUBLIC. If the `DbGroups` parameter is specifed, `DbUser` # is added to the listed groups for any sessions created using these # credentials. # @return [String] # # @!attribute [rw] db_password # A temporary password that authorizes the user name returned by # `DbUser` to log on to the database `DbName`. # @return [String] # # @!attribute [rw] expiration # The date and time the password in `DbPassword` expires. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterCredentials AWS API Documentation # class ClusterCredentials < Struct.new( :db_user, :db_password, :expiration) SENSITIVE = [:db_password] include Aws::Structure end # Describes a `ClusterDbRevision`. # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster. # @return [String] # # @!attribute [rw] current_database_revision # A string representing the current cluster version. # @return [String] # # @!attribute [rw] database_revision_release_date # The date on which the database revision was released. # @return [Time] # # @!attribute [rw] revision_targets # A list of `RevisionTarget` objects, where each object describes the # database revision that a cluster can be updated to. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterDbRevision AWS API Documentation # class ClusterDbRevision < Struct.new( :cluster_identifier, :current_database_revision, :database_revision_release_date, :revision_targets) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] marker # A string representing the starting point for the next set of # revisions. If a value is returned in a response, you can retrieve # the next set of revisions by providing the value in the `marker` # parameter and retrying the command. If the `marker` field is empty, # all revisions have already been returned. # @return [String] # # @!attribute [rw] cluster_db_revisions # A list of revisions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterDbRevisionsMessage AWS API Documentation # class ClusterDbRevisionsMessage < Struct.new( :marker, :cluster_db_revisions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] db_user # A database user name that you provide when you connect to a # database. The database user is mapped 1:1 to the source IAM # identity. # @return [String] # # @!attribute [rw] db_password # A temporary password that you provide when you connect to a # database. # @return [String] # # @!attribute [rw] expiration # The time (UTC) when the temporary password expires. After this # timestamp, a log in with the temporary password fails. # @return [Time] # # @!attribute [rw] next_refresh_time # Reserved for future use. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterExtendedCredentials AWS API Documentation # class ClusterExtendedCredentials < Struct.new( :db_user, :db_password, :expiration, :next_refresh_time) SENSITIVE = [:db_password] include Aws::Structure end # An Identity and Access Management (IAM) role that can be used by the # associated Amazon Redshift cluster to access other Amazon Web Services # services. # # @!attribute [rw] iam_role_arn # The Amazon Resource Name (ARN) of the IAM role, for example, # `arn:aws:iam::123456789012:role/RedshiftCopyUnload`. # @return [String] # # @!attribute [rw] apply_status # A value that describes the status of the IAM role's association # with an Amazon Redshift cluster. # # The following are possible statuses and descriptions. # # * `in-sync`\: The role is available for use by the cluster. # # * `adding`\: The role is in the process of being associated with the # cluster. # # * `removing`\: The role is in the process of being disassociated # with the cluster. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterIamRole AWS API Documentation # class ClusterIamRole < Struct.new( :iam_role_arn, :apply_status) SENSITIVE = [] include Aws::Structure end # The identifier of a node in a cluster. # # @!attribute [rw] node_role # Whether the node is a leader node or a compute node. # @return [String] # # @!attribute [rw] private_ip_address # The private IP address of a node within a cluster. # @return [String] # # @!attribute [rw] public_ip_address # The public IP address of a node within a cluster. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterNode AWS API Documentation # class ClusterNode < Struct.new( :node_role, :private_ip_address, :public_ip_address) SENSITIVE = [] include Aws::Structure end # The `ClusterIdentifier` parameter does not refer to an existing # cluster. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterNotFoundFault AWS API Documentation # class ClusterNotFoundFault < Aws::EmptyStructure; end # Cluster is already on the latest database revision. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterOnLatestRevisionFault AWS API Documentation # class ClusterOnLatestRevisionFault < Aws::EmptyStructure; end # Describes a parameter group. # # @!attribute [rw] parameter_group_name # The name of the cluster parameter group. # @return [String] # # @!attribute [rw] parameter_group_family # The name of the cluster parameter group family that this cluster # parameter group is compatible with. # @return [String] # # @!attribute [rw] description # The description of the parameter group. # @return [String] # # @!attribute [rw] tags # The list of tags for the cluster parameter group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroup AWS API Documentation # class ClusterParameterGroup < Struct.new( :parameter_group_name, :parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end # A cluster parameter group with the same name already exists. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupAlreadyExistsFault AWS API Documentation # class ClusterParameterGroupAlreadyExistsFault < Aws::EmptyStructure; end # Contains the output from the DescribeClusterParameters action. # # @!attribute [rw] parameters # A list of Parameter instances. Each instance lists the parameters of # one cluster parameter group. # @return [Array] # # @!attribute [rw] marker # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupDetails AWS API Documentation # class ClusterParameterGroupDetails < Struct.new( :parameters, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] parameter_group_name # The name of the cluster parameter group. # @return [String] # # @!attribute [rw] parameter_group_status # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupNameMessage AWS API Documentation # class ClusterParameterGroupNameMessage < Struct.new( :parameter_group_name, :parameter_group_status) SENSITIVE = [] include Aws::Structure end # The parameter group name does not refer to an existing parameter # group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupNotFoundFault AWS API Documentation # class ClusterParameterGroupNotFoundFault < Aws::EmptyStructure; end # 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][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupQuotaExceededFault AWS API Documentation # class ClusterParameterGroupQuotaExceededFault < Aws::EmptyStructure; end # Describes the status of a parameter group. # # @!attribute [rw] parameter_group_name # The name of the cluster parameter group. # @return [String] # # @!attribute [rw] parameter_apply_status # The status of parameter updates. # @return [String] # # @!attribute [rw] cluster_parameter_status_list # The list of parameter statuses. # # For more information about parameters and parameter groups, go to # [Amazon Redshift Parameter Groups][1] in the *Amazon Redshift # Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupStatus AWS API Documentation # class ClusterParameterGroupStatus < Struct.new( :parameter_group_name, :parameter_apply_status, :cluster_parameter_status_list) SENSITIVE = [] include Aws::Structure end # Contains the output from the DescribeClusterParameterGroups action. # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] parameter_groups # A list of ClusterParameterGroup instances. Each instance describes # one cluster parameter group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterGroupsMessage AWS API Documentation # class ClusterParameterGroupsMessage < Struct.new( :marker, :parameter_groups) SENSITIVE = [] include Aws::Structure end # Describes the status of a parameter group. # # @!attribute [rw] parameter_name # The name of the parameter. # @return [String] # # @!attribute [rw] parameter_apply_status # 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. # @return [String] # # @!attribute [rw] parameter_apply_error_description # The error that prevented the parameter from being applied to the # database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterParameterStatus AWS API Documentation # class ClusterParameterStatus < Struct.new( :parameter_name, :parameter_apply_status, :parameter_apply_error_description) SENSITIVE = [] include Aws::Structure end # 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][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterQuotaExceededFault AWS API Documentation # class ClusterQuotaExceededFault < Aws::EmptyStructure; end # Describes a security group. # # @!attribute [rw] cluster_security_group_name # The name of the cluster security group to which the operation was # applied. # @return [String] # # @!attribute [rw] description # A description of the security group. # @return [String] # # @!attribute [rw] ec2_security_groups # A list of EC2 security groups that are permitted to access clusters # associated with this cluster security group. # @return [Array] # # @!attribute [rw] ip_ranges # A list of IP ranges (CIDR blocks) that are permitted to access # clusters associated with this cluster security group. # @return [Array] # # @!attribute [rw] tags # The list of tags for the cluster security group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroup AWS API Documentation # class ClusterSecurityGroup < Struct.new( :cluster_security_group_name, :description, :ec2_security_groups, :ip_ranges, :tags) SENSITIVE = [] include Aws::Structure end # A cluster security group with the same name already exists. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroupAlreadyExistsFault AWS API Documentation # class ClusterSecurityGroupAlreadyExistsFault < Aws::EmptyStructure; end # Describes a cluster security group. # # @!attribute [rw] cluster_security_group_name # The name of the cluster security group. # @return [String] # # @!attribute [rw] status # The status of the cluster security group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroupMembership AWS API Documentation # class ClusterSecurityGroupMembership < Struct.new( :cluster_security_group_name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] cluster_security_groups # A list of ClusterSecurityGroup instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroupMessage AWS API Documentation # class ClusterSecurityGroupMessage < Struct.new( :marker, :cluster_security_groups) SENSITIVE = [] include Aws::Structure end # The cluster security group name does not refer to an existing cluster # security group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroupNotFoundFault AWS API Documentation # class ClusterSecurityGroupNotFoundFault < Aws::EmptyStructure; end # 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][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSecurityGroupQuotaExceededFault AWS API Documentation # class ClusterSecurityGroupQuotaExceededFault < Aws::EmptyStructure; end # The value specified as a snapshot identifier is already used by an # existing snapshot. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSnapshotAlreadyExistsFault AWS API Documentation # class ClusterSnapshotAlreadyExistsFault < Aws::EmptyStructure; end # Returns the destination region and retention period that are # configured for cross-region snapshot copy. # # @!attribute [rw] destination_region # The destination region that snapshots are automatically copied to # when cross-region snapshot copy is enabled. # @return [String] # # @!attribute [rw] retention_period # The number of days that automated snapshots are retained in the # destination region after they are copied from a source region. # @return [Integer] # # @!attribute [rw] manual_snapshot_retention_period # The number of days that automated snapshots are retained in the # destination region after they are copied from a source region. If # the value is -1, the manual snapshot is retained indefinitely. # # The value must be either -1 or an integer between 1 and 3,653. # @return [Integer] # # @!attribute [rw] snapshot_copy_grant_name # The name of the snapshot copy grant. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSnapshotCopyStatus AWS API Documentation # class ClusterSnapshotCopyStatus < Struct.new( :destination_region, :retention_period, :manual_snapshot_retention_period, :snapshot_copy_grant_name) SENSITIVE = [] include Aws::Structure end # The snapshot identifier does not refer to an existing cluster # snapshot. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSnapshotNotFoundFault AWS API Documentation # class ClusterSnapshotNotFoundFault < Aws::EmptyStructure; end # The request would result in the user exceeding the allowed number of # cluster snapshots. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSnapshotQuotaExceededFault AWS API Documentation # class ClusterSnapshotQuotaExceededFault < Aws::EmptyStructure; end # Describes a subnet group. # # @!attribute [rw] cluster_subnet_group_name # The name of the cluster subnet group. # @return [String] # # @!attribute [rw] description # The description of the cluster subnet group. # @return [String] # # @!attribute [rw] vpc_id # The VPC ID of the cluster subnet group. # @return [String] # # @!attribute [rw] subnet_group_status # The status of the cluster subnet group. Possible values are # `Complete`, `Incomplete` and `Invalid`. # @return [String] # # @!attribute [rw] subnets # A list of the VPC Subnet elements. # @return [Array] # # @!attribute [rw] tags # The list of tags for the cluster subnet group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetGroup AWS API Documentation # class ClusterSubnetGroup < Struct.new( :cluster_subnet_group_name, :description, :vpc_id, :subnet_group_status, :subnets, :tags) SENSITIVE = [] include Aws::Structure end # A *ClusterSubnetGroupName* is already used by an existing cluster # subnet group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetGroupAlreadyExistsFault AWS API Documentation # class ClusterSubnetGroupAlreadyExistsFault < Aws::EmptyStructure; end # Contains the output from the DescribeClusterSubnetGroups action. # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] cluster_subnet_groups # A list of ClusterSubnetGroup instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetGroupMessage AWS API Documentation # class ClusterSubnetGroupMessage < Struct.new( :marker, :cluster_subnet_groups) SENSITIVE = [] include Aws::Structure end # The cluster subnet group name does not refer to an existing cluster # subnet group. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetGroupNotFoundFault AWS API Documentation # class ClusterSubnetGroupNotFoundFault < Aws::EmptyStructure; end # 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][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetGroupQuotaExceededFault AWS API Documentation # class ClusterSubnetGroupQuotaExceededFault < Aws::EmptyStructure; end # 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][1] in the *Amazon # Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterSubnetQuotaExceededFault AWS API Documentation # class ClusterSubnetQuotaExceededFault < Aws::EmptyStructure; end # Describes a cluster version, including the parameter group family and # description of the version. # # @!attribute [rw] cluster_version # The version number used by the cluster. # @return [String] # # @!attribute [rw] cluster_parameter_group_family # The name of the cluster parameter group family for the cluster. # @return [String] # # @!attribute [rw] description # The description of the cluster version. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterVersion AWS API Documentation # class ClusterVersion < Struct.new( :cluster_version, :cluster_parameter_group_family, :description) SENSITIVE = [] include Aws::Structure end # Contains the output from the DescribeClusterVersions action. # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] cluster_versions # A list of `Version` elements. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClusterVersionsMessage AWS API Documentation # class ClusterVersionsMessage < Struct.new( :marker, :cluster_versions) SENSITIVE = [] include Aws::Structure end # Contains the output from the DescribeClusters action. # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] clusters # A list of `Cluster` objects, where each object describes one # cluster. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ClustersMessage AWS API Documentation # class ClustersMessage < Struct.new( :marker, :clusters) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CopyClusterSnapshotMessage # data as a hash: # # { # source_snapshot_identifier: "String", # required # source_snapshot_cluster_identifier: "String", # target_snapshot_identifier: "String", # required # manual_snapshot_retention_period: 1, # } # # @!attribute [rw] source_snapshot_identifier # The identifier for the source snapshot. # # Constraints: # # * Must be the identifier for a valid automated snapshot whose state # is `available`. # # ^ # @return [String] # # @!attribute [rw] source_snapshot_cluster_identifier # The identifier of the cluster the source snapshot was created from. # This parameter is required if your IAM user has a policy containing # a snapshot resource element that specifies anything other than * # for the cluster name. # # Constraints: # # * Must be the identifier for a valid cluster. # # ^ # @return [String] # # @!attribute [rw] target_snapshot_identifier # The identifier given to the new manual snapshot. # # Constraints: # # * Cannot be null, empty, or blank. # # * Must contain from 1 to 255 alphanumeric characters or hyphens. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique for the Amazon Web Services account that is making # the request. # @return [String] # # @!attribute [rw] manual_snapshot_retention_period # The number of days that a manual snapshot is retained. If the value # is -1, the manual snapshot is retained indefinitely. # # The value must be either -1 or an integer between 1 and 3,653. # # The default value is -1. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CopyClusterSnapshotMessage AWS API Documentation # class CopyClusterSnapshotMessage < Struct.new( :source_snapshot_identifier, :source_snapshot_cluster_identifier, :target_snapshot_identifier, :manual_snapshot_retention_period) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CopyClusterSnapshotResult AWS API Documentation # class CopyClusterSnapshotResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # Cross-region snapshot copy was temporarily disabled. Try your request # again. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CopyToRegionDisabledFault AWS API Documentation # class CopyToRegionDisabledFault < Aws::EmptyStructure; end # @note When making an API call, you may pass CreateAuthenticationProfileMessage # data as a hash: # # { # authentication_profile_name: "AuthenticationProfileNameString", # required # authentication_profile_content: "String", # required # } # # @!attribute [rw] authentication_profile_name # The name of the authentication profile to be created. # @return [String] # # @!attribute [rw] authentication_profile_content # The content of the authentication profile in JSON format. The # maximum length of the JSON string is determined by a quota for your # account. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateAuthenticationProfileMessage AWS API Documentation # class CreateAuthenticationProfileMessage < Struct.new( :authentication_profile_name, :authentication_profile_content) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] authentication_profile_name # The name of the authentication profile that was created. # @return [String] # # @!attribute [rw] authentication_profile_content # The content of the authentication profile in JSON format. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateAuthenticationProfileResult AWS API Documentation # class CreateAuthenticationProfileResult < Struct.new( :authentication_profile_name, :authentication_profile_content) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateClusterMessage # data as a hash: # # { # db_name: "String", # cluster_identifier: "String", # required # cluster_type: "String", # node_type: "String", # required # master_username: "String", # required # master_user_password: "String", # required # cluster_security_groups: ["String"], # vpc_security_group_ids: ["String"], # cluster_subnet_group_name: "String", # availability_zone: "String", # preferred_maintenance_window: "String", # cluster_parameter_group_name: "String", # automated_snapshot_retention_period: 1, # manual_snapshot_retention_period: 1, # port: 1, # cluster_version: "String", # allow_version_upgrade: false, # number_of_nodes: 1, # publicly_accessible: false, # encrypted: false, # hsm_client_certificate_identifier: "String", # hsm_configuration_identifier: "String", # elastic_ip: "String", # tags: [ # { # key: "String", # value: "String", # }, # ], # kms_key_id: "String", # enhanced_vpc_routing: false, # additional_info: "String", # iam_roles: ["String"], # maintenance_track_name: "String", # snapshot_schedule_identifier: "String", # availability_zone_relocation: false, # aqua_configuration_status: "enabled", # accepts enabled, disabled, auto # default_iam_role_arn: "String", # load_sample_data: "String", # } # # @!attribute [rw] db_name # The name of the first database to be created when the cluster is # created. # # To create additional databases after the cluster is created, connect # to the cluster with a SQL client and use SQL commands to create a # database. For more information, go to [Create a Database][1] in the # Amazon Redshift Database Developer Guide. # # Default: `dev` # # Constraints: # # * Must contain 1 to 64 alphanumeric characters. # # * Must contain only lowercase letters. # # * Cannot be a word that is reserved by the service. A list of # reserved words can be found in [Reserved Words][2] in the Amazon # Redshift Database Developer Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html # [2]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] cluster_identifier # A unique identifier for the cluster. You use this identifier to # refer to the cluster for any subsequent cluster operations such as # deleting or modifying. The identifier also appears in the Amazon # Redshift console. # # Constraints: # # * Must contain from 1 to 63 alphanumeric characters or hyphens. # # * Alphabetic characters must be lowercase. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique for all clusters within an Amazon Web Services # account. # # Example: `myexamplecluster` # @return [String] # # @!attribute [rw] cluster_type # The type of the cluster. When cluster type is specified as # # * `single-node`, the **NumberOfNodes** parameter is not required. # # * `multi-node`, the **NumberOfNodes** parameter is required. # # Valid Values: `multi-node` \| `single-node` # # Default: `multi-node` # @return [String] # # @!attribute [rw] node_type # The node type to be provisioned for the cluster. For information # about node types, go to [ Working with Clusters][1] in the *Amazon # Redshift Cluster Management Guide*. # # Valid Values: `ds2.xlarge` \| `ds2.8xlarge` \| `dc1.large` \| # `dc1.8xlarge` \| `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| # `ra3.4xlarge` \| `ra3.16xlarge` # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes # @return [String] # # @!attribute [rw] master_username # The user name associated with the admin user account for the cluster # that is being created. # # Constraints: # # * Must be 1 - 128 alphanumeric characters. The user name can't be # `PUBLIC`. # # * First character must be a letter. # # * Cannot be a reserved word. A list of reserved words can be found # in [Reserved Words][1] in the Amazon Redshift Database Developer # Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] master_user_password # The password associated with the admin user account for the cluster # that is being created. # # Constraints: # # * Must be between 8 and 64 characters in length. # # * Must contain at least one uppercase letter. # # * Must contain at least one lowercase letter. # # * Must contain one number. # # * Can be any printable ASCII character (ASCII code 33-126) except # `'` (single quote), `"` (double quote), ``, `/`, or `@`. # @return [String] # # @!attribute [rw] cluster_security_groups # A list of security groups to be associated with this cluster. # # Default: The default cluster security group for Amazon Redshift. # @return [Array] # # @!attribute [rw] vpc_security_group_ids # A list of Virtual Private Cloud (VPC) security groups to be # associated with the cluster. # # Default: The default VPC security group is associated with the # cluster. # @return [Array] # # @!attribute [rw] cluster_subnet_group_name # The name of a cluster subnet group to be associated with this # cluster. # # If this parameter is not provided the resulting cluster will be # deployed outside virtual private cloud (VPC). # @return [String] # # @!attribute [rw] availability_zone # The EC2 Availability Zone (AZ) in which you want Amazon Redshift to # provision the cluster. For example, if you have several EC2 # instances running in a specific Availability Zone, then you might # want the cluster to be provisioned in the same zone in order to # decrease network latency. # # Default: A random, system-chosen Availability Zone in the region # that is specified by the endpoint. # # Example: `us-east-2d` # # Constraint: The specified Availability Zone must be in the same # region as the current endpoint. # @return [String] # # @!attribute [rw] preferred_maintenance_window # The weekly time range (in UTC) during which automated cluster # maintenance can occur. # # Format: `ddd:hh24:mi-ddd:hh24:mi` # # Default: A 30-minute window selected at random from an 8-hour block # of time per region, occurring on a random day of the week. For more # information about the time blocks for each region, see [Maintenance # Windows][1] in Amazon Redshift Cluster Management Guide. # # Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun # # Constraints: Minimum 30-minute window. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows # @return [String] # # @!attribute [rw] cluster_parameter_group_name # The name of the parameter group to be associated with this cluster. # # Default: The default Amazon Redshift cluster parameter group. For # information about the default parameter group, go to [Working with # Amazon Redshift Parameter Groups][1] # # Constraints: # # * Must be 1 to 255 alphanumeric characters or hyphens. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html # @return [String] # # @!attribute [rw] automated_snapshot_retention_period # The number of days that automated snapshots are retained. If the # value is 0, automated snapshots are disabled. Even if automated # snapshots are disabled, you can still create manual snapshots when # you want with CreateClusterSnapshot. # # You can't disable automated snapshots for RA3 node types. Set the # automated retention period from 1-35 days. # # Default: `1` # # Constraints: Must be a value from 0 to 35. # @return [Integer] # # @!attribute [rw] manual_snapshot_retention_period # 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. # @return [Integer] # # @!attribute [rw] port # The port number on which the cluster accepts incoming connections. # # The cluster is accessible only via the JDBC and ODBC connection # strings. Part of the connection string requires the port on which # the cluster will listen for incoming connections. # # Default: `5439` # # Valid Values: `1150-65535` # @return [Integer] # # @!attribute [rw] cluster_version # The version of the Amazon Redshift engine software that you want to # deploy on the cluster. # # The version selected runs on all the nodes in the cluster. # # Constraints: Only version 1.0 is currently available. # # Example: `1.0` # @return [String] # # @!attribute [rw] allow_version_upgrade # If `true`, major version upgrades can be applied during the # maintenance window to the Amazon Redshift engine that is running on # the cluster. # # When a new major version of the Amazon Redshift engine is released, # you can request that the service automatically apply upgrades during # the maintenance window to the Amazon Redshift engine that is running # on your cluster. # # Default: `true` # @return [Boolean] # # @!attribute [rw] number_of_nodes # The number of compute nodes in the cluster. This parameter is # required when the **ClusterType** parameter is specified as # `multi-node`. # # For information about determining how many nodes you need, go to [ # Working with Clusters][1] in the *Amazon Redshift Cluster Management # Guide*. # # If you don't specify this parameter, you get a single-node cluster. # When requesting a multi-node cluster, you must specify the number of # nodes that you want in the cluster. # # Default: `1` # # Constraints: Value must be at least 1 and no more than 100. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes # @return [Integer] # # @!attribute [rw] publicly_accessible # If `true`, the cluster can be accessed from a public network. # @return [Boolean] # # @!attribute [rw] encrypted # If `true`, the data in the cluster is encrypted at rest. # # Default: false # @return [Boolean] # # @!attribute [rw] hsm_client_certificate_identifier # Specifies the name of the HSM client certificate the Amazon Redshift # cluster uses to retrieve the data encryption keys stored in an HSM. # @return [String] # # @!attribute [rw] hsm_configuration_identifier # 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. # @return [String] # # @!attribute [rw] elastic_ip # The Elastic IP (EIP) address for the cluster. # # Constraints: The cluster must be provisioned in EC2-VPC and # publicly-accessible through an Internet gateway. For more # information about provisioning clusters in EC2-VPC, go to [Supported # Platforms to Launch Your Cluster][1] in the Amazon Redshift Cluster # Management Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @!attribute [rw] kms_key_id # The Key Management Service (KMS) key ID of the encryption key that # you want to use to encrypt data in the cluster. # @return [String] # # @!attribute [rw] enhanced_vpc_routing # 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][1] in the Amazon Redshift Cluster Management # Guide. # # If this option is `true`, enhanced VPC routing is enabled. # # Default: false # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html # @return [Boolean] # # @!attribute [rw] additional_info # Reserved. # @return [String] # # @!attribute [rw] iam_roles # A list of Identity and Access Management (IAM) roles that can be # used by the cluster to access other Amazon Web Services services. # You must supply the IAM roles in their Amazon Resource Name (ARN) # format. # # The maximum number of IAM roles that you can associate is subject to # a quota. For more information, go to [Quotas and limits][1] in the # *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # @return [Array] # # @!attribute [rw] maintenance_track_name # An optional parameter for the name of the maintenance track for the # cluster. If you don't provide a maintenance track name, the cluster # is assigned to the `current` track. # @return [String] # # @!attribute [rw] snapshot_schedule_identifier # A unique identifier for the snapshot schedule. # @return [String] # # @!attribute [rw] availability_zone_relocation # The option to enable relocation for an Amazon Redshift cluster # between Availability Zones after the cluster is created. # @return [Boolean] # # @!attribute [rw] aqua_configuration_status # The value represents how the cluster is configured to use AQUA # (Advanced Query Accelerator) when it is created. Possible values # include the following. # # * enabled - Use AQUA if it is available for the current Amazon Web # Services Region and Amazon Redshift node type. # # * disabled - Don't use AQUA. # # * auto - Amazon Redshift determines whether to use AQUA. # @return [String] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) for the IAM role that was set as # default for the cluster when the cluster was created. # @return [String] # # @!attribute [rw] load_sample_data # A flag that specifies whether to load sample data once the cluster # is created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterMessage AWS API Documentation # class CreateClusterMessage < Struct.new( :db_name, :cluster_identifier, :cluster_type, :node_type, :master_username, :master_user_password, :cluster_security_groups, :vpc_security_group_ids, :cluster_subnet_group_name, :availability_zone, :preferred_maintenance_window, :cluster_parameter_group_name, :automated_snapshot_retention_period, :manual_snapshot_retention_period, :port, :cluster_version, :allow_version_upgrade, :number_of_nodes, :publicly_accessible, :encrypted, :hsm_client_certificate_identifier, :hsm_configuration_identifier, :elastic_ip, :tags, :kms_key_id, :enhanced_vpc_routing, :additional_info, :iam_roles, :maintenance_track_name, :snapshot_schedule_identifier, :availability_zone_relocation, :aqua_configuration_status, :default_iam_role_arn, :load_sample_data) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateClusterParameterGroupMessage # data as a hash: # # { # parameter_group_name: "String", # required # parameter_group_family: "String", # required # description: "String", # required # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] parameter_group_name # The name of the cluster parameter group. # # Constraints: # # * Must be 1 to 255 alphanumeric characters or hyphens # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique withing your Amazon Web Services account. # # This value is stored as a lower-case string. # # # @return [String] # # @!attribute [rw] parameter_group_family # The Amazon Redshift engine version to which the cluster parameter # group applies. The cluster engine version determines the set of # parameters. # # To get a list of valid parameter group family names, you can call # DescribeClusterParameterGroups. By default, Amazon Redshift returns # a list of all the parameter groups that are owned by your Amazon Web # Services account, including the default parameter groups for each # Amazon Redshift engine version. The parameter group family names # associated with the default parameter groups provide you the valid # values. For example, a valid family name is "redshift-1.0". # @return [String] # # @!attribute [rw] description # A description of the parameter group. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterParameterGroupMessage AWS API Documentation # class CreateClusterParameterGroupMessage < Struct.new( :parameter_group_name, :parameter_group_family, :description, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_parameter_group # Describes a parameter group. # @return [Types::ClusterParameterGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterParameterGroupResult AWS API Documentation # class CreateClusterParameterGroupResult < Struct.new( :cluster_parameter_group) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterResult AWS API Documentation # class CreateClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateClusterSecurityGroupMessage # data as a hash: # # { # cluster_security_group_name: "String", # required # description: "String", # required # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] cluster_security_group_name # The name for the security group. Amazon Redshift stores the value as # a lowercase string. # # Constraints: # # * Must contain no more than 255 alphanumeric characters or hyphens. # # * Must not be "Default". # # * Must be unique for all security groups that are created by your # Amazon Web Services account. # # Example: `examplesecuritygroup` # @return [String] # # @!attribute [rw] description # A description for the security group. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSecurityGroupMessage AWS API Documentation # class CreateClusterSecurityGroupMessage < Struct.new( :cluster_security_group_name, :description, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_security_group # Describes a security group. # @return [Types::ClusterSecurityGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSecurityGroupResult AWS API Documentation # class CreateClusterSecurityGroupResult < Struct.new( :cluster_security_group) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateClusterSnapshotMessage # data as a hash: # # { # snapshot_identifier: "String", # required # cluster_identifier: "String", # required # manual_snapshot_retention_period: 1, # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] snapshot_identifier # A unique identifier for the snapshot that you are requesting. This # identifier must be unique for all snapshots within the Amazon Web # Services account. # # Constraints: # # * Cannot be null, empty, or blank # # * Must contain from 1 to 255 alphanumeric characters or hyphens # # * First character must be a letter # # * Cannot end with a hyphen or contain two consecutive hyphens # # Example: `my-snapshot-id` # @return [String] # # @!attribute [rw] cluster_identifier # The cluster identifier for which you want a snapshot. # @return [String] # # @!attribute [rw] manual_snapshot_retention_period # The number of days that a manual snapshot is retained. If the value # is -1, the manual snapshot is retained indefinitely. # # The value must be either -1 or an integer between 1 and 3,653. # # The default value is -1. # @return [Integer] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSnapshotMessage AWS API Documentation # class CreateClusterSnapshotMessage < Struct.new( :snapshot_identifier, :cluster_identifier, :manual_snapshot_retention_period, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSnapshotResult AWS API Documentation # class CreateClusterSnapshotResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateClusterSubnetGroupMessage # data as a hash: # # { # cluster_subnet_group_name: "String", # required # description: "String", # required # subnet_ids: ["String"], # required # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] cluster_subnet_group_name # The name for the subnet group. Amazon Redshift stores the value as a # lowercase string. # # Constraints: # # * Must contain no more than 255 alphanumeric characters or hyphens. # # * Must not be "Default". # # * Must be unique for all subnet groups that are created by your # Amazon Web Services account. # # Example: `examplesubnetgroup` # @return [String] # # @!attribute [rw] description # A description for the subnet group. # @return [String] # # @!attribute [rw] subnet_ids # An array of VPC subnet IDs. A maximum of 20 subnets can be modified # in a single request. # @return [Array] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSubnetGroupMessage AWS API Documentation # class CreateClusterSubnetGroupMessage < Struct.new( :cluster_subnet_group_name, :description, :subnet_ids, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_subnet_group # Describes a subnet group. # @return [Types::ClusterSubnetGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateClusterSubnetGroupResult AWS API Documentation # class CreateClusterSubnetGroupResult < Struct.new( :cluster_subnet_group) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateEndpointAccessMessage # data as a hash: # # { # cluster_identifier: "String", # resource_owner: "String", # endpoint_name: "String", # required # subnet_group_name: "String", # required # vpc_security_group_ids: ["String"], # } # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster to access. # @return [String] # # @!attribute [rw] resource_owner # The Amazon Web Services account ID of the owner of the cluster. This # is only required if the cluster is in another Amazon Web Services # account. # @return [String] # # @!attribute [rw] endpoint_name # The Redshift-managed VPC endpoint name. # # An endpoint name must contain 1-30 characters. Valid characters are # A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. # The name can't contain two consecutive hyphens or end with a # hyphen. # @return [String] # # @!attribute [rw] subnet_group_name # The subnet group from which Amazon Redshift chooses the subnet to # deploy the endpoint. # @return [String] # # @!attribute [rw] vpc_security_group_ids # The security group that defines the ports, protocols, and sources # for inbound traffic that you are authorizing into your endpoint. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateEndpointAccessMessage AWS API Documentation # class CreateEndpointAccessMessage < Struct.new( :cluster_identifier, :resource_owner, :endpoint_name, :subnet_group_name, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateEventSubscriptionMessage # data as a hash: # # { # subscription_name: "String", # required # sns_topic_arn: "String", # required # source_type: "String", # source_ids: ["String"], # event_categories: ["String"], # severity: "String", # enabled: false, # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] subscription_name # The name of the event subscription to be created. # # Constraints: # # * Cannot be null, empty, or blank. # # * Must contain from 1 to 255 alphanumeric characters or hyphens. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # @return [String] # # @!attribute [rw] sns_topic_arn # The Amazon Resource Name (ARN) of the Amazon SNS topic used to # transmit the event notifications. The ARN is created by Amazon SNS # when you create a topic and subscribe to it. # @return [String] # # @!attribute [rw] source_type # The type of source that will be generating the events. For example, # if you want to be notified of events generated by a cluster, you # would set this parameter to cluster. If this value is not specified, # events are returned for all Amazon Redshift objects in your Amazon # Web Services account. You must specify a source type in order to # specify source IDs. # # Valid values: cluster, cluster-parameter-group, # cluster-security-group, cluster-snapshot, and scheduled-action. # @return [String] # # @!attribute [rw] source_ids # A list of one or more identifiers of Amazon Redshift source objects. # All of the objects must be of the same type as was specified in the # source type parameter. The event subscription will return only # events generated by the specified objects. If not specified, then # events are returned for all objects within the source type # specified. # # Example: my-cluster-1, my-cluster-2 # # Example: my-snapshot-20131010 # @return [Array] # # @!attribute [rw] event_categories # Specifies the Amazon Redshift event categories to be published by # the event notification subscription. # # Values: configuration, management, monitoring, security, pending # @return [Array] # # @!attribute [rw] severity # Specifies the Amazon Redshift event severity to be published by the # event notification subscription. # # Values: ERROR, INFO # @return [String] # # @!attribute [rw] enabled # A boolean value; set to `true` to activate the subscription, and set # to `false` to create the subscription but not activate it. # @return [Boolean] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateEventSubscriptionMessage AWS API Documentation # class CreateEventSubscriptionMessage < Struct.new( :subscription_name, :sns_topic_arn, :source_type, :source_ids, :event_categories, :severity, :enabled, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] event_subscription # Describes event subscriptions. # @return [Types::EventSubscription] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateEventSubscriptionResult AWS API Documentation # class CreateEventSubscriptionResult < Struct.new( :event_subscription) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateHsmClientCertificateMessage # data as a hash: # # { # hsm_client_certificate_identifier: "String", # required # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] hsm_client_certificate_identifier # The identifier to be assigned to the new HSM client certificate that # the cluster will use to connect to the HSM to use the database # encryption keys. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateHsmClientCertificateMessage AWS API Documentation # class CreateHsmClientCertificateMessage < Struct.new( :hsm_client_certificate_identifier, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] hsm_client_certificate # 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. # @return [Types::HsmClientCertificate] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateHsmClientCertificateResult AWS API Documentation # class CreateHsmClientCertificateResult < Struct.new( :hsm_client_certificate) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateHsmConfigurationMessage # data as a hash: # # { # hsm_configuration_identifier: "String", # required # description: "String", # required # hsm_ip_address: "String", # required # hsm_partition_name: "String", # required # hsm_partition_password: "String", # required # hsm_server_public_certificate: "String", # required # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] hsm_configuration_identifier # The identifier to be assigned to the new Amazon Redshift HSM # configuration. # @return [String] # # @!attribute [rw] description # A text description of the HSM configuration to be created. # @return [String] # # @!attribute [rw] hsm_ip_address # The IP address that the Amazon Redshift cluster must use to access # the HSM. # @return [String] # # @!attribute [rw] hsm_partition_name # The name of the partition in the HSM where the Amazon Redshift # clusters will store their database encryption keys. # @return [String] # # @!attribute [rw] hsm_partition_password # The password required to access the HSM partition. # @return [String] # # @!attribute [rw] hsm_server_public_certificate # The HSMs public certificate file. When using Cloud HSM, the file # name is server.pem. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateHsmConfigurationMessage AWS API Documentation # class CreateHsmConfigurationMessage < Struct.new( :hsm_configuration_identifier, :description, :hsm_ip_address, :hsm_partition_name, :hsm_partition_password, :hsm_server_public_certificate, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] hsm_configuration # 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. # @return [Types::HsmConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateHsmConfigurationResult AWS API Documentation # class CreateHsmConfigurationResult < Struct.new( :hsm_configuration) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateScheduledActionMessage # data as a hash: # # { # scheduled_action_name: "String", # required # target_action: { # required # resize_cluster: { # cluster_identifier: "String", # required # cluster_type: "String", # node_type: "String", # number_of_nodes: 1, # classic: false, # reserved_node_id: "String", # target_reserved_node_offering_id: "String", # }, # pause_cluster: { # cluster_identifier: "String", # required # }, # resume_cluster: { # cluster_identifier: "String", # required # }, # }, # schedule: "String", # required # iam_role: "String", # required # scheduled_action_description: "String", # start_time: Time.now, # end_time: Time.now, # enable: false, # } # # @!attribute [rw] scheduled_action_name # The name of the scheduled action. The name must be unique within an # account. For more information about this parameter, see # ScheduledAction. # @return [String] # # @!attribute [rw] target_action # A JSON format string of the Amazon Redshift API operation with input # parameters. For more information about this parameter, see # ScheduledAction. # @return [Types::ScheduledActionType] # # @!attribute [rw] schedule # The schedule in `at( )` or `cron( )` format. For more information # about this parameter, see ScheduledAction. # @return [String] # # @!attribute [rw] iam_role # The IAM role to assume to run the target action. For more # information about this parameter, see ScheduledAction. # @return [String] # # @!attribute [rw] scheduled_action_description # The description of the scheduled action. # @return [String] # # @!attribute [rw] start_time # The start time in UTC of the scheduled action. Before this time, the # scheduled action does not trigger. For more information about this # parameter, see ScheduledAction. # @return [Time] # # @!attribute [rw] end_time # The end time in UTC of the scheduled action. After this time, the # scheduled action does not trigger. For more information about this # parameter, see ScheduledAction. # @return [Time] # # @!attribute [rw] enable # If true, the schedule is enabled. If false, the scheduled action # does not trigger. For more information about `state` of the # scheduled action, see ScheduledAction. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateScheduledActionMessage AWS API Documentation # class CreateScheduledActionMessage < Struct.new( :scheduled_action_name, :target_action, :schedule, :iam_role, :scheduled_action_description, :start_time, :end_time, :enable) SENSITIVE = [] include Aws::Structure end # The result of the `CreateSnapshotCopyGrant` action. # # @note When making an API call, you may pass CreateSnapshotCopyGrantMessage # data as a hash: # # { # snapshot_copy_grant_name: "String", # required # kms_key_id: "String", # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] snapshot_copy_grant_name # The name of the snapshot copy grant. This name must be unique in the # region for the Amazon Web Services account. # # Constraints: # # * Must contain from 1 to 63 alphanumeric characters or hyphens. # # * Alphabetic characters must be lowercase. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique for all clusters within an Amazon Web Services # account. # @return [String] # # @!attribute [rw] kms_key_id # The unique identifier of the encrypted symmetric key to which to # grant Amazon Redshift permission. If no key is specified, the # default key is used. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateSnapshotCopyGrantMessage AWS API Documentation # class CreateSnapshotCopyGrantMessage < Struct.new( :snapshot_copy_grant_name, :kms_key_id, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot_copy_grant # The snapshot copy grant that grants Amazon Redshift permission to # encrypt copied snapshots with the specified encrypted symmetric key # from Amazon Web Services KMS in the destination region. # # For more information about managing snapshot copy grants, go to # [Amazon Redshift Database Encryption][1] in the *Amazon Redshift # Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html # @return [Types::SnapshotCopyGrant] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateSnapshotCopyGrantResult AWS API Documentation # class CreateSnapshotCopyGrantResult < Struct.new( :snapshot_copy_grant) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateSnapshotScheduleMessage # data as a hash: # # { # schedule_definitions: ["String"], # schedule_identifier: "String", # schedule_description: "String", # tags: [ # { # key: "String", # value: "String", # }, # ], # dry_run: false, # next_invocations: 1, # } # # @!attribute [rw] schedule_definitions # The definition of the snapshot schedule. The definition is made up # of schedule expressions, for example "cron(30 12 *)" or "rate(12 # hours)". # @return [Array] # # @!attribute [rw] schedule_identifier # A unique identifier for a snapshot schedule. Only alphanumeric # characters are allowed for the identifier. # @return [String] # # @!attribute [rw] schedule_description # The description of the snapshot schedule. # @return [String] # # @!attribute [rw] tags # An optional set of tags you can use to search for the schedule. # @return [Array] # # @!attribute [rw] dry_run # @return [Boolean] # # @!attribute [rw] next_invocations # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateSnapshotScheduleMessage AWS API Documentation # class CreateSnapshotScheduleMessage < Struct.new( :schedule_definitions, :schedule_identifier, :schedule_description, :tags, :dry_run, :next_invocations) SENSITIVE = [] include Aws::Structure end # Contains the output from the `CreateTags` action. # # @note When making an API call, you may pass CreateTagsMessage # data as a hash: # # { # resource_name: "String", # required # tags: [ # required # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] resource_name # The Amazon Resource Name (ARN) to which you want to add the tag or # tags. For example, # `arn:aws:redshift:us-east-2:123456789:cluster:t1`. # @return [String] # # @!attribute [rw] tags # One or more name/value pairs to add as tags to the specified # resource. Each tag name is passed in with the parameter `Key` and # the corresponding value is passed in with the parameter `Value`. The # `Key` and `Value` parameters are separated by a comma (,). Separate # multiple tags with a space. For example, `--tags # "Key"="owner","Value"="admin" "Key"="environment","Value"="test" # "Key"="version","Value"="1.0"`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateTagsMessage AWS API Documentation # class CreateTagsMessage < Struct.new( :resource_name, :tags) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass CreateUsageLimitMessage # data as a hash: # # { # cluster_identifier: "String", # required # feature_type: "spectrum", # required, accepts spectrum, concurrency-scaling, cross-region-datasharing # limit_type: "time", # required, accepts time, data-scanned # amount: 1, # required # period: "daily", # accepts daily, weekly, monthly # breach_action: "log", # accepts log, emit-metric, disable # tags: [ # { # key: "String", # value: "String", # }, # ], # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster that you want to limit usage. # @return [String] # # @!attribute [rw] feature_type # The Amazon Redshift feature that you want to limit. # @return [String] # # @!attribute [rw] limit_type # The type of limit. Depending on the feature type, this can be based # on a time duration or data size. If `FeatureType` is `spectrum`, # then `LimitType` must be `data-scanned`. If `FeatureType` is # `concurrency-scaling`, then `LimitType` must be `time`. If # `FeatureType` is `cross-region-datasharing`, then `LimitType` must # be `data-scanned`. # @return [String] # # @!attribute [rw] amount # The limit amount. If time-based, this amount is in minutes. If # data-based, this amount is in terabytes (TB). The value must be a # positive number. # @return [Integer] # # @!attribute [rw] period # The time period that the amount applies to. A `weekly` period begins # on Sunday. The default is `monthly`. # @return [String] # # @!attribute [rw] breach_action # The action that Amazon Redshift takes when the limit is reached. The # default is log. For more information about this parameter, see # UsageLimit. # @return [String] # # @!attribute [rw] tags # A list of tag instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CreateUsageLimitMessage AWS API Documentation # class CreateUsageLimitMessage < Struct.new( :cluster_identifier, :feature_type, :limit_type, :amount, :period, :breach_action, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] total_backup_size_in_mega_bytes # The total amount of storage currently used for snapshots. # @return [Float] # # @!attribute [rw] total_provisioned_storage_in_mega_bytes # The total amount of storage currently provisioned. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/CustomerStorageMessage AWS API Documentation # class CustomerStorageMessage < Struct.new( :total_backup_size_in_mega_bytes, :total_provisioned_storage_in_mega_bytes) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_share_arn # An Amazon Resource Name (ARN) that references the datashare that is # owned by a specific namespace of the producer cluster. A datashare # ARN is in the # `arn:aws:redshift:\{region\}:\{account-id\}:\{datashare\}:\{namespace-guid\}/\{datashare-name\}` # format. # @return [String] # # @!attribute [rw] producer_arn # The Amazon Resource Name (ARN) of the producer. # @return [String] # # @!attribute [rw] allow_publicly_accessible_consumers # A value that specifies whether the datashare can be shared to a # publicly accessible cluster. # @return [Boolean] # # @!attribute [rw] data_share_associations # A value that specifies when the datashare has an association between # producer and data consumers. # @return [Array] # # @!attribute [rw] managed_by # The identifier of a datashare to show its managing entity. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DataShare AWS API Documentation # class DataShare < Struct.new( :data_share_arn, :producer_arn, :allow_publicly_accessible_consumers, :data_share_associations, :managed_by) SENSITIVE = [] include Aws::Structure end # The association of a datashare from a producer account with a data # consumer. # # @!attribute [rw] consumer_identifier # The name of the consumer accounts that have an association with a # producer datashare. # @return [String] # # @!attribute [rw] status # The status of the datashare that is associated. # @return [String] # # @!attribute [rw] consumer_region # The Amazon Web Services Region of the consumer accounts that have an # association with a producer datashare. # @return [String] # # @!attribute [rw] created_date # The creation date of the datashare that is associated. # @return [Time] # # @!attribute [rw] status_change_date # The status change data of the datashare that is associated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DataShareAssociation AWS API Documentation # class DataShareAssociation < Struct.new( :consumer_identifier, :status, :consumer_region, :created_date, :status_change_date) SENSITIVE = [] include Aws::Structure end # Describes the status of a cluster while it is in the process of # resizing with an incremental resize. # # @!attribute [rw] status # Describes the status of the cluster. While the transfer is in # progress the status is `transferringdata`. # @return [String] # # @!attribute [rw] current_rate_in_mega_bytes_per_second # Describes the data transfer rate in MB's per second. # @return [Float] # # @!attribute [rw] total_data_in_mega_bytes # Describes the total amount of data to be transfered in megabytes. # @return [Integer] # # @!attribute [rw] data_transferred_in_mega_bytes # Describes the total amount of data that has been transfered in # MB's. # @return [Integer] # # @!attribute [rw] estimated_time_to_completion_in_seconds # Describes the estimated number of seconds remaining to complete the # transfer. # @return [Integer] # # @!attribute [rw] elapsed_time_in_seconds # Describes the number of seconds that have elapsed during the data # transfer. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DataTransferProgress AWS API Documentation # class DataTransferProgress < Struct.new( :status, :current_rate_in_mega_bytes_per_second, :total_data_in_mega_bytes, :data_transferred_in_mega_bytes, :estimated_time_to_completion_in_seconds, :elapsed_time_in_seconds) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeauthorizeDataShareMessage # data as a hash: # # { # data_share_arn: "String", # required # consumer_identifier: "String", # required # } # # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare to remove # authorization from. # @return [String] # # @!attribute [rw] consumer_identifier # The identifier of the data consumer that is to have authorization # removed from the datashare. This identifier is an Amazon Web # Services account ID or a keyword, such as ADX. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeauthorizeDataShareMessage AWS API Documentation # class DeauthorizeDataShareMessage < Struct.new( :data_share_arn, :consumer_identifier) SENSITIVE = [] include Aws::Structure end # Describes the default cluster parameters for a parameter group family. # # @!attribute [rw] parameter_group_family # The name of the cluster parameter group family to which the engine # default parameters apply. # @return [String] # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] parameters # The list of cluster default parameters. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DefaultClusterParameters AWS API Documentation # class DefaultClusterParameters < Struct.new( :parameter_group_family, :marker, :parameters) SENSITIVE = [] include Aws::Structure end # Describes a deferred maintenance window # # @!attribute [rw] defer_maintenance_identifier # A unique identifier for the maintenance window. # @return [String] # # @!attribute [rw] defer_maintenance_start_time # A timestamp for the beginning of the time period when we defer # maintenance. # @return [Time] # # @!attribute [rw] defer_maintenance_end_time # A timestamp for the end of the time period when we defer # maintenance. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeferredMaintenanceWindow AWS API Documentation # class DeferredMaintenanceWindow < Struct.new( :defer_maintenance_identifier, :defer_maintenance_start_time, :defer_maintenance_end_time) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteAuthenticationProfileMessage # data as a hash: # # { # authentication_profile_name: "AuthenticationProfileNameString", # required # } # # @!attribute [rw] authentication_profile_name # The name of the authentication profile to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteAuthenticationProfileMessage AWS API Documentation # class DeleteAuthenticationProfileMessage < Struct.new( :authentication_profile_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] authentication_profile_name # The name of the authentication profile that was deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteAuthenticationProfileResult AWS API Documentation # class DeleteAuthenticationProfileResult < Struct.new( :authentication_profile_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # skip_final_cluster_snapshot: false, # final_cluster_snapshot_identifier: "String", # final_cluster_snapshot_retention_period: 1, # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster to be deleted. # # Constraints: # # * Must contain lowercase characters. # # * Must contain from 1 to 63 alphanumeric characters or hyphens. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # @return [String] # # @!attribute [rw] skip_final_cluster_snapshot # Determines whether a final snapshot of the cluster is created before # Amazon Redshift deletes the cluster. If `true`, a final cluster # snapshot is not created. If `false`, a final cluster snapshot is # created before the cluster is deleted. # # The *FinalClusterSnapshotIdentifier* parameter must be specified if # *SkipFinalClusterSnapshot* is `false`. # # # # Default: `false` # @return [Boolean] # # @!attribute [rw] final_cluster_snapshot_identifier # The identifier of the final snapshot that is to be created # immediately before deleting the cluster. If this parameter is # provided, *SkipFinalClusterSnapshot* must be `false`. # # Constraints: # # * Must be 1 to 255 alphanumeric characters. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # @return [String] # # @!attribute [rw] final_cluster_snapshot_retention_period # The number of days that a manual snapshot is retained. If the value # is -1, the manual snapshot is retained indefinitely. # # The value must be either -1 or an integer between 1 and 3,653. # # The default value is -1. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterMessage AWS API Documentation # class DeleteClusterMessage < Struct.new( :cluster_identifier, :skip_final_cluster_snapshot, :final_cluster_snapshot_identifier, :final_cluster_snapshot_retention_period) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteClusterParameterGroupMessage # data as a hash: # # { # parameter_group_name: "String", # required # } # # @!attribute [rw] parameter_group_name # The name of the parameter group to be deleted. # # Constraints: # # * Must be the name of an existing cluster parameter group. # # * Cannot delete a default cluster parameter group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterParameterGroupMessage AWS API Documentation # class DeleteClusterParameterGroupMessage < Struct.new( :parameter_group_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterResult AWS API Documentation # class DeleteClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteClusterSecurityGroupMessage # data as a hash: # # { # cluster_security_group_name: "String", # required # } # # @!attribute [rw] cluster_security_group_name # The name of the cluster security group to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterSecurityGroupMessage AWS API Documentation # class DeleteClusterSecurityGroupMessage < Struct.new( :cluster_security_group_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteClusterSnapshotMessage # data as a hash: # # { # snapshot_identifier: "String", # required # snapshot_cluster_identifier: "String", # } # # @!attribute [rw] snapshot_identifier # The unique identifier of the manual snapshot to be deleted. # # Constraints: Must be the name of an existing snapshot that is in the # `available`, `failed`, or `cancelled` state. # @return [String] # # @!attribute [rw] snapshot_cluster_identifier # The unique identifier of the cluster the snapshot was created from. # This parameter is required if your IAM user has a policy containing # a snapshot resource element that specifies anything other than * # for the cluster name. # # Constraints: Must be the name of valid cluster. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterSnapshotMessage AWS API Documentation # class DeleteClusterSnapshotMessage < Struct.new( :snapshot_identifier, :snapshot_cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterSnapshotResult AWS API Documentation # class DeleteClusterSnapshotResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteClusterSubnetGroupMessage # data as a hash: # # { # cluster_subnet_group_name: "String", # required # } # # @!attribute [rw] cluster_subnet_group_name # The name of the cluster subnet group name to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteClusterSubnetGroupMessage AWS API Documentation # class DeleteClusterSubnetGroupMessage < Struct.new( :cluster_subnet_group_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteEndpointAccessMessage # data as a hash: # # { # endpoint_name: "String", # required # } # # @!attribute [rw] endpoint_name # The Redshift-managed VPC endpoint to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteEndpointAccessMessage AWS API Documentation # class DeleteEndpointAccessMessage < Struct.new( :endpoint_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteEventSubscriptionMessage # data as a hash: # # { # subscription_name: "String", # required # } # # @!attribute [rw] subscription_name # The name of the Amazon Redshift event notification subscription to # be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteEventSubscriptionMessage AWS API Documentation # class DeleteEventSubscriptionMessage < Struct.new( :subscription_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteHsmClientCertificateMessage # data as a hash: # # { # hsm_client_certificate_identifier: "String", # required # } # # @!attribute [rw] hsm_client_certificate_identifier # The identifier of the HSM client certificate to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteHsmClientCertificateMessage AWS API Documentation # class DeleteHsmClientCertificateMessage < Struct.new( :hsm_client_certificate_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteHsmConfigurationMessage # data as a hash: # # { # hsm_configuration_identifier: "String", # required # } # # @!attribute [rw] hsm_configuration_identifier # The identifier of the Amazon Redshift HSM configuration to be # deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteHsmConfigurationMessage AWS API Documentation # class DeleteHsmConfigurationMessage < Struct.new( :hsm_configuration_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteScheduledActionMessage # data as a hash: # # { # scheduled_action_name: "String", # required # } # # @!attribute [rw] scheduled_action_name # The name of the scheduled action to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteScheduledActionMessage AWS API Documentation # class DeleteScheduledActionMessage < Struct.new( :scheduled_action_name) SENSITIVE = [] include Aws::Structure end # The result of the `DeleteSnapshotCopyGrant` action. # # @note When making an API call, you may pass DeleteSnapshotCopyGrantMessage # data as a hash: # # { # snapshot_copy_grant_name: "String", # required # } # # @!attribute [rw] snapshot_copy_grant_name # The name of the snapshot copy grant to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteSnapshotCopyGrantMessage AWS API Documentation # class DeleteSnapshotCopyGrantMessage < Struct.new( :snapshot_copy_grant_name) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteSnapshotScheduleMessage # data as a hash: # # { # schedule_identifier: "String", # required # } # # @!attribute [rw] schedule_identifier # A unique identifier of the snapshot schedule to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteSnapshotScheduleMessage AWS API Documentation # class DeleteSnapshotScheduleMessage < Struct.new( :schedule_identifier) SENSITIVE = [] include Aws::Structure end # Contains the output from the `DeleteTags` action. # # @note When making an API call, you may pass DeleteTagsMessage # data as a hash: # # { # resource_name: "String", # required # tag_keys: ["String"], # required # } # # @!attribute [rw] resource_name # The Amazon Resource Name (ARN) from which you want to remove the tag # or tags. For example, # `arn:aws:redshift:us-east-2:123456789:cluster:t1`. # @return [String] # # @!attribute [rw] tag_keys # The tag key that you want to delete. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteTagsMessage AWS API Documentation # class DeleteTagsMessage < Struct.new( :resource_name, :tag_keys) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DeleteUsageLimitMessage # data as a hash: # # { # usage_limit_id: "String", # required # } # # @!attribute [rw] usage_limit_id # The identifier of the usage limit to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DeleteUsageLimitMessage AWS API Documentation # class DeleteUsageLimitMessage < Struct.new( :usage_limit_id) SENSITIVE = [] include Aws::Structure end # The request cannot be completed because a dependent service is # throttling requests made by Amazon Redshift on your behalf. Wait and # retry the request. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DependentServiceRequestThrottlingFault AWS API Documentation # class DependentServiceRequestThrottlingFault < Aws::EmptyStructure; end # Your request cannot be completed because a dependent internal service # is temporarily unavailable. Wait 30 to 60 seconds and try again. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DependentServiceUnavailableFault AWS API Documentation # class DependentServiceUnavailableFault < Aws::EmptyStructure; end # @note When making an API call, you may pass DescribeAccountAttributesMessage # data as a hash: # # { # attribute_names: ["String"], # } # # @!attribute [rw] attribute_names # A list of attribute names. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeAccountAttributesMessage AWS API Documentation # class DescribeAccountAttributesMessage < Struct.new( :attribute_names) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeAuthenticationProfilesMessage # data as a hash: # # { # authentication_profile_name: "AuthenticationProfileNameString", # } # # @!attribute [rw] authentication_profile_name # The name of the authentication profile to describe. If not specified # then all authentication profiles owned by the account are listed. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeAuthenticationProfilesMessage AWS API Documentation # class DescribeAuthenticationProfilesMessage < Struct.new( :authentication_profile_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] authentication_profiles # The list of authentication profiles. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeAuthenticationProfilesResult AWS API Documentation # class DescribeAuthenticationProfilesResult < Struct.new( :authentication_profiles) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterDbRevisionsMessage # data as a hash: # # { # cluster_identifier: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_identifier # A unique identifier for a cluster whose `ClusterDbRevisions` you are # requesting. This parameter is case sensitive. All clusters defined # for an account are returned by default. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # MaxRecords value, a value is returned in the `marker` field of the # response. You can retrieve the next set of response records by # providing the returned `marker` value in the `marker` parameter and # retrying the request. # # Default: 100 # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point for # returning a set of response records. When the results of a # `DescribeClusterDbRevisions` request exceed the value specified in # `MaxRecords`, Amazon Redshift returns a value in the `marker` field # of the response. You can retrieve the next set of response records # by providing the returned `marker` value in the `marker` parameter # and retrying the request. # # Constraints: You can specify either the `ClusterIdentifier` # parameter, or the `marker` parameter, but not both. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterDbRevisionsMessage AWS API Documentation # class DescribeClusterDbRevisionsMessage < Struct.new( :cluster_identifier, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterParameterGroupsMessage # data as a hash: # # { # parameter_group_name: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] parameter_group_name # The name of a specific parameter group for which to return details. # By default, details about all parameter groups and the default # parameter group are returned. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterParameterGroups request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching cluster # parameter groups that are associated with the specified key or keys. # For example, suppose that you have parameter groups that are tagged # with keys called `owner` and `environment`. If you specify both of # these tag keys in the request, Amazon Redshift returns a response # with the parameter groups that have either or both of these tag keys # associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # cluster parameter groups that are associated with the specified tag # value or values. For example, suppose that you have parameter groups # that are tagged with values called `admin` and `test`. If you # specify both of these tag values in the request, Amazon Redshift # returns a response with the parameter groups that have either or # both of these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterParameterGroupsMessage AWS API Documentation # class DescribeClusterParameterGroupsMessage < Struct.new( :parameter_group_name, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterParametersMessage # data as a hash: # # { # parameter_group_name: "String", # required # source: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] parameter_group_name # The name of a cluster parameter group for which to return details. # @return [String] # # @!attribute [rw] source # The parameter types to return. Specify `user` to show parameters # that are different form the default. Similarly, specify # `engine-default` to show parameters that are the same as the default # parameter group. # # Default: All parameter types returned. # # Valid Values: `user` \| `engine-default` # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterParameters request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterParametersMessage AWS API Documentation # class DescribeClusterParametersMessage < Struct.new( :parameter_group_name, :source, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterSecurityGroupsMessage # data as a hash: # # { # cluster_security_group_name: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] cluster_security_group_name # The name of a cluster security group for which you are requesting # details. You can specify either the **Marker** parameter or a # **ClusterSecurityGroupName** parameter, but not both. # # Example: `securitygroup1` # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterSecurityGroups request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # # Constraints: You can specify either the **ClusterSecurityGroupName** # parameter or the **Marker** parameter, but not both. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching cluster # security groups that are associated with the specified key or keys. # For example, suppose that you have security groups that are tagged # with keys called `owner` and `environment`. If you specify both of # these tag keys in the request, Amazon Redshift returns a response # with the security groups that have either or both of these tag keys # associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # cluster security groups that are associated with the specified tag # value or values. For example, suppose that you have security groups # that are tagged with values called `admin` and `test`. If you # specify both of these tag values in the request, Amazon Redshift # returns a response with the security groups that have either or both # of these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterSecurityGroupsMessage AWS API Documentation # class DescribeClusterSecurityGroupsMessage < Struct.new( :cluster_security_group_name, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterSnapshotsMessage # data as a hash: # # { # cluster_identifier: "String", # snapshot_identifier: "String", # snapshot_type: "String", # start_time: Time.now, # end_time: Time.now, # max_records: 1, # marker: "String", # owner_account: "String", # tag_keys: ["String"], # tag_values: ["String"], # cluster_exists: false, # sorting_entities: [ # { # attribute: "SOURCE_TYPE", # required, accepts SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME # sort_order: "ASC", # accepts ASC, DESC # }, # ], # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster which generated the requested # snapshots. # @return [String] # # @!attribute [rw] snapshot_identifier # The snapshot identifier of the snapshot about which to return # information. # @return [String] # # @!attribute [rw] snapshot_type # The type of snapshots for which you are requesting information. By # default, snapshots of all types are returned. # # Valid Values: `automated` \| `manual` # @return [String] # # @!attribute [rw] start_time # A value that requests only snapshots created at or after the # specified time. The time value is specified in ISO 8601 format. For # more information about ISO 8601, go to the [ISO8601 Wikipedia # page.][1] # # Example: `2012-07-16T18:00:00Z` # # # # [1]: http://en.wikipedia.org/wiki/ISO_8601 # @return [Time] # # @!attribute [rw] end_time # A time value that requests only snapshots created at or before the # specified time. The time value is specified in ISO 8601 format. For # more information about ISO 8601, go to the [ISO8601 Wikipedia # page.][1] # # Example: `2012-07-16T18:00:00Z` # # # # [1]: http://en.wikipedia.org/wiki/ISO_8601 # @return [Time] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterSnapshots request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] owner_account # The Amazon Web Services account used to create or copy the snapshot. # Use this field to filter the results to snapshots owned by a # particular account. To describe snapshots you own, either specify # your Amazon Web Services account, or do not specify the parameter. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching cluster # snapshots that are associated with the specified key or keys. For # example, suppose that you have snapshots that are tagged with keys # called `owner` and `environment`. If you specify both of these tag # keys in the request, Amazon Redshift returns a response with the # snapshots that have either or both of these tag keys associated with # them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # cluster snapshots that are associated with the specified tag value # or values. For example, suppose that you have snapshots that are # tagged with values called `admin` and `test`. If you specify both of # these tag values in the request, Amazon Redshift returns a response # with the snapshots that have either or both of these tag values # associated with them. # @return [Array] # # @!attribute [rw] cluster_exists # A value that indicates whether to return snapshots only for an # existing cluster. You can perform table-level restore only by using # a snapshot of an existing cluster, that is, a cluster that has not # been deleted. Values for this parameter work as follows: # # * If `ClusterExists` is set to `true`, `ClusterIdentifier` is # required. # # * If `ClusterExists` is set to `false` and `ClusterIdentifier` # isn't specified, all snapshots associated with deleted clusters # (orphaned snapshots) are returned. # # * If `ClusterExists` is set to `false` and `ClusterIdentifier` is # specified for a deleted cluster, snapshots associated with that # cluster are returned. # # * If `ClusterExists` is set to `false` and `ClusterIdentifier` is # specified for an existing cluster, no snapshots are returned. # @return [Boolean] # # @!attribute [rw] sorting_entities # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterSnapshotsMessage AWS API Documentation # class DescribeClusterSnapshotsMessage < Struct.new( :cluster_identifier, :snapshot_identifier, :snapshot_type, :start_time, :end_time, :max_records, :marker, :owner_account, :tag_keys, :tag_values, :cluster_exists, :sorting_entities) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterSubnetGroupsMessage # data as a hash: # # { # cluster_subnet_group_name: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] cluster_subnet_group_name # The name of the cluster subnet group for which information is # requested. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterSubnetGroups request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching cluster # subnet groups that are associated with the specified key or keys. # For example, suppose that you have subnet groups that are tagged # with keys called `owner` and `environment`. If you specify both of # these tag keys in the request, Amazon Redshift returns a response # with the subnet groups that have either or both of these tag keys # associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # cluster subnet groups that are associated with the specified tag # value or values. For example, suppose that you have subnet groups # that are tagged with values called `admin` and `test`. If you # specify both of these tag values in the request, Amazon Redshift # returns a response with the subnet groups that have either or both # of these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterSubnetGroupsMessage AWS API Documentation # class DescribeClusterSubnetGroupsMessage < Struct.new( :cluster_subnet_group_name, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterTracksMessage # data as a hash: # # { # maintenance_track_name: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] maintenance_track_name # The name of the maintenance track. # @return [String] # # @!attribute [rw] max_records # An integer value for the maximum number of maintenance tracks to # return. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # `DescribeClusterTracks` request exceed the value specified in # `MaxRecords`, Amazon Redshift returns a value in the `Marker` field # of the response. You can retrieve the next set of response records # by providing the returned marker value in the `Marker` parameter and # retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterTracksMessage AWS API Documentation # class DescribeClusterTracksMessage < Struct.new( :maintenance_track_name, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClusterVersionsMessage # data as a hash: # # { # cluster_version: "String", # cluster_parameter_group_family: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_version # The specific cluster version to return. # # Example: `1.0` # @return [String] # # @!attribute [rw] cluster_parameter_group_family # The name of a specific cluster parameter group family to return # details for. # # Constraints: # # * Must be 1 to 255 alphanumeric characters # # * First character must be a letter # # * Cannot end with a hyphen or contain two consecutive hyphens # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeClusterVersions request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterVersionsMessage AWS API Documentation # class DescribeClusterVersionsMessage < Struct.new( :cluster_version, :cluster_parameter_group_family, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeClustersMessage # data as a hash: # # { # cluster_identifier: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] cluster_identifier # The unique identifier of a cluster whose properties you are # requesting. This parameter is case sensitive. # # The default is that all clusters defined for an account are # returned. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeClusters # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # # Constraints: You can specify either the **ClusterIdentifier** # parameter or the **Marker** parameter, but not both. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching clusters # that are associated with the specified key or keys. For example, # suppose that you have clusters that are tagged with keys called # `owner` and `environment`. If you specify both of these tag keys in # the request, Amazon Redshift returns a response with the clusters # that have either or both of these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # clusters that are associated with the specified tag value or values. # For example, suppose that you have clusters that are tagged with # values called `admin` and `test`. If you specify both of these tag # values in the request, Amazon Redshift returns a response with the # clusters that have either or both of these tag values associated # with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClustersMessage AWS API Documentation # class DescribeClustersMessage < Struct.new( :cluster_identifier, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeDataSharesForConsumerMessage # data as a hash: # # { # consumer_arn: "String", # status: "ACTIVE", # accepts ACTIVE, AVAILABLE # max_records: 1, # marker: "String", # } # # @!attribute [rw] consumer_arn # The Amazon Resource Name (ARN) of the consumer that returns in the # list of datashares. # @return [String] # # @!attribute [rw] status # An identifier giving the status of a datashare in the consumer # cluster. If this field is specified, Amazon Redshift returns the # list of datashares that have the specified status. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeDataSharesForConsumer request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesForConsumerMessage AWS API Documentation # class DescribeDataSharesForConsumerMessage < Struct.new( :consumer_arn, :status, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_shares # Shows the results of datashares available for consumers. # @return [Array] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeDataSharesForConsumer request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesForConsumerResult AWS API Documentation # class DescribeDataSharesForConsumerResult < Struct.new( :data_shares, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeDataSharesForProducerMessage # data as a hash: # # { # producer_arn: "String", # status: "ACTIVE", # accepts ACTIVE, AUTHORIZED, PENDING_AUTHORIZATION, DEAUTHORIZED, REJECTED # max_records: 1, # marker: "String", # } # # @!attribute [rw] producer_arn # The Amazon Resource Name (ARN) of the producer that returns in the # list of datashares. # @return [String] # # @!attribute [rw] status # An identifier giving the status of a datashare in the producer. If # this field is specified, Amazon Redshift returns the list of # datashares that have the specified status. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeDataSharesForProducer request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesForProducerMessage AWS API Documentation # class DescribeDataSharesForProducerMessage < Struct.new( :producer_arn, :status, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_shares # Shows the results of datashares available for producers. # @return [Array] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeDataSharesForProducer request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesForProducerResult AWS API Documentation # class DescribeDataSharesForProducerResult < Struct.new( :data_shares, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeDataSharesMessage # data as a hash: # # { # data_share_arn: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] data_share_arn # The identifier of the datashare to describe details of. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeDataShares # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesMessage AWS API Documentation # class DescribeDataSharesMessage < Struct.new( :data_share_arn, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] data_shares # The results returned from describing datashares. # @return [Array] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeDataShares # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDataSharesResult AWS API Documentation # class DescribeDataSharesResult < Struct.new( :data_shares, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeDefaultClusterParametersMessage # data as a hash: # # { # parameter_group_family: "String", # required # max_records: 1, # marker: "String", # } # # @!attribute [rw] parameter_group_family # The name of the cluster parameter group family. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeDefaultClusterParameters request exceed the value specified # in `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDefaultClusterParametersMessage AWS API Documentation # class DescribeDefaultClusterParametersMessage < Struct.new( :parameter_group_family, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] default_cluster_parameters # Describes the default cluster parameters for a parameter group # family. # @return [Types::DefaultClusterParameters] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeDefaultClusterParametersResult AWS API Documentation # class DescribeDefaultClusterParametersResult < Struct.new( :default_cluster_parameters) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeEndpointAccessMessage # data as a hash: # # { # cluster_identifier: "String", # resource_owner: "String", # endpoint_name: "String", # vpc_id: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_identifier # The cluster identifier associated with the described endpoint. # @return [String] # # @!attribute [rw] resource_owner # The Amazon Web Services account ID of the owner of the cluster. # @return [String] # # @!attribute [rw] endpoint_name # The name of the endpoint to be described. # @return [String] # # @!attribute [rw] vpc_id # The virtual private cloud (VPC) identifier with access to the # cluster. # @return [String] # # @!attribute [rw] max_records # The maximum number of records to include in the response. If more # records exist than the specified `MaxRecords` value, a pagination # token called a `Marker` is included in the response so that the # remaining results can be retrieved. # @return [Integer] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeEndpointAccess` request. If this parameter is specified, # the response includes only records beyond the marker, up to the # value specified by the `MaxRecords` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEndpointAccessMessage AWS API Documentation # class DescribeEndpointAccessMessage < Struct.new( :cluster_identifier, :resource_owner, :endpoint_name, :vpc_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeEndpointAuthorizationMessage # data as a hash: # # { # cluster_identifier: "String", # account: "String", # grantee: false, # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster to access. # @return [String] # # @!attribute [rw] account # The AAmazon Web Services account ID of either the cluster owner # (grantor) or grantee. If `Grantee` parameter is true, then the # `Account` value is of the grantor. # @return [String] # # @!attribute [rw] grantee # Indicates whether to check authorization from a grantor or grantee # point of view. If true, Amazon Redshift returns endpoint # authorizations that you've been granted. If false (default), checks # authorization from a grantor point of view. # @return [Boolean] # # @!attribute [rw] max_records # The maximum number of records to include in the response. If more # records exist than the specified `MaxRecords` value, a pagination # token called a `Marker` is included in the response so that the # remaining results can be retrieved. # @return [Integer] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeEndpointAuthorization` request. If this parameter is # specified, the response includes only records beyond the marker, up # to the value specified by the `MaxRecords` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEndpointAuthorizationMessage AWS API Documentation # class DescribeEndpointAuthorizationMessage < Struct.new( :cluster_identifier, :account, :grantee, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeEventCategoriesMessage # data as a hash: # # { # source_type: "String", # } # # @!attribute [rw] source_type # The source type, such as cluster or parameter group, to which the # described event categories apply. # # Valid values: cluster, cluster-snapshot, cluster-parameter-group, # cluster-security-group, and scheduled-action. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEventCategoriesMessage AWS API Documentation # class DescribeEventCategoriesMessage < Struct.new( :source_type) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeEventSubscriptionsMessage # data as a hash: # # { # subscription_name: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] subscription_name # The name of the Amazon Redshift event notification subscription to # be described. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeEventSubscriptions request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching event # notification subscriptions that are associated with the specified # key or keys. For example, suppose that you have subscriptions that # are tagged with keys called `owner` and `environment`. If you # specify both of these tag keys in the request, Amazon Redshift # returns a response with the subscriptions that have either or both # of these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # event notification subscriptions that are associated with the # specified tag value or values. For example, suppose that you have # subscriptions that are tagged with values called `admin` and `test`. # If you specify both of these tag values in the request, Amazon # Redshift returns a response with the subscriptions that have either # or both of these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEventSubscriptionsMessage AWS API Documentation # class DescribeEventSubscriptionsMessage < Struct.new( :subscription_name, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeEventsMessage # data as a hash: # # { # source_identifier: "String", # source_type: "cluster", # accepts cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, scheduled-action # start_time: Time.now, # end_time: Time.now, # duration: 1, # max_records: 1, # marker: "String", # } # # @!attribute [rw] source_identifier # The identifier of the event source for which events will be # returned. If this parameter is not specified, then all sources are # included in the response. # # Constraints: # # If *SourceIdentifier* is supplied, *SourceType* must also be # provided. # # * Specify a cluster identifier when *SourceType* is `cluster`. # # * Specify a cluster security group name when *SourceType* is # `cluster-security-group`. # # * Specify a cluster parameter group name when *SourceType* is # `cluster-parameter-group`. # # * Specify a cluster snapshot identifier when *SourceType* is # `cluster-snapshot`. # @return [String] # # @!attribute [rw] source_type # The event source to retrieve events for. If no value is specified, # all events are returned. # # Constraints: # # If *SourceType* is supplied, *SourceIdentifier* must also be # provided. # # * Specify `cluster` when *SourceIdentifier* is a cluster identifier. # # * Specify `cluster-security-group` when *SourceIdentifier* is a # cluster security group name. # # * Specify `cluster-parameter-group` when *SourceIdentifier* is a # cluster parameter group name. # # * Specify `cluster-snapshot` when *SourceIdentifier* is a cluster # snapshot identifier. # @return [String] # # @!attribute [rw] start_time # The beginning of the time interval to retrieve events for, specified # in ISO 8601 format. For more information about ISO 8601, go to the # [ISO8601 Wikipedia page.][1] # # Example: `2009-07-08T18:00Z` # # # # [1]: http://en.wikipedia.org/wiki/ISO_8601 # @return [Time] # # @!attribute [rw] end_time # The end of the time interval for which to retrieve events, specified # in ISO 8601 format. For more information about ISO 8601, go to the # [ISO8601 Wikipedia page.][1] # # Example: `2009-07-08T18:00Z` # # # # [1]: http://en.wikipedia.org/wiki/ISO_8601 # @return [Time] # # @!attribute [rw] duration # The number of minutes prior to the time of the request for which to # retrieve events. For example, if the request is sent at 18:00 and # you specify a duration of 60, then only events which have occurred # after 17:00 will be returned. # # Default: `60` # @return [Integer] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeEvents # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeEventsMessage AWS API Documentation # class DescribeEventsMessage < Struct.new( :source_identifier, :source_type, :start_time, :end_time, :duration, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeHsmClientCertificatesMessage # data as a hash: # # { # hsm_client_certificate_identifier: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] hsm_client_certificate_identifier # The identifier of a specific HSM client certificate for which you # want information. If no identifier is specified, information is # returned for all HSM client certificates owned by your Amazon Web # Services account. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeHsmClientCertificates request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching HSM # client certificates that are associated with the specified key or # keys. For example, suppose that you have HSM client certificates # that are tagged with keys called `owner` and `environment`. If you # specify both of these tag keys in the request, Amazon Redshift # returns a response with the HSM client certificates that have either # or both of these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching HSM # client certificates that are associated with the specified tag value # or values. For example, suppose that you have HSM client # certificates that are tagged with values called `admin` and `test`. # If you specify both of these tag values in the request, Amazon # Redshift returns a response with the HSM client certificates that # have either or both of these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeHsmClientCertificatesMessage AWS API Documentation # class DescribeHsmClientCertificatesMessage < Struct.new( :hsm_client_certificate_identifier, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeHsmConfigurationsMessage # data as a hash: # # { # hsm_configuration_identifier: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] hsm_configuration_identifier # The identifier of a specific Amazon Redshift HSM configuration to be # described. If no identifier is specified, information is returned # for all HSM configurations owned by your Amazon Web Services # account. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeHsmConfigurations request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching HSM # configurations that are associated with the specified key or keys. # For example, suppose that you have HSM configurations that are # tagged with keys called `owner` and `environment`. If you specify # both of these tag keys in the request, Amazon Redshift returns a # response with the HSM configurations that have either or both of # these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching HSM # configurations that are associated with the specified tag value or # values. For example, suppose that you have HSM configurations that # are tagged with values called `admin` and `test`. If you specify # both of these tag values in the request, Amazon Redshift returns a # response with the HSM configurations that have either or both of # these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeHsmConfigurationsMessage AWS API Documentation # class DescribeHsmConfigurationsMessage < Struct.new( :hsm_configuration_identifier, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeLoggingStatusMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster from which to get the logging status. # # Example: `examplecluster` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeLoggingStatusMessage AWS API Documentation # class DescribeLoggingStatusMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeNodeConfigurationOptionsMessage # data as a hash: # # { # action_type: "restore-cluster", # required, accepts restore-cluster, recommend-node-config, resize-cluster # cluster_identifier: "String", # snapshot_identifier: "String", # owner_account: "String", # filters: [ # { # name: "NodeType", # accepts NodeType, NumberOfNodes, EstimatedDiskUtilizationPercent, Mode # operator: "eq", # accepts eq, lt, gt, le, ge, in, between # values: ["String"], # }, # ], # marker: "String", # max_records: 1, # } # # @!attribute [rw] action_type # The action type to evaluate for possible node configurations. # Specify "restore-cluster" to get configuration combinations based # on an existing snapshot. Specify "recommend-node-config" to get # configuration recommendations based on an existing cluster or # snapshot. Specify "resize-cluster" to get configuration # combinations for elastic resize based on an existing cluster. # @return [String] # # @!attribute [rw] cluster_identifier # The identifier of the cluster to evaluate for possible node # configurations. # @return [String] # # @!attribute [rw] snapshot_identifier # The identifier of the snapshot to evaluate for possible node # configurations. # @return [String] # # @!attribute [rw] owner_account # The Amazon Web Services account used to create or copy the snapshot. # Required if you are restoring a snapshot you do not own, optional if # you own the snapshot. # @return [String] # # @!attribute [rw] filters # A set of name, operator, and value items to filter the results. # @return [Array] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeNodeConfigurationOptions request exceed the value specified # in `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `500` # # Constraints: minimum 100, maximum 500. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeNodeConfigurationOptionsMessage AWS API Documentation # class DescribeNodeConfigurationOptionsMessage < Struct.new( :action_type, :cluster_identifier, :snapshot_identifier, :owner_account, :filters, :marker, :max_records) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeOrderableClusterOptionsMessage # data as a hash: # # { # cluster_version: "String", # node_type: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_version # The version filter value. Specify this parameter to show only the # available offerings matching the specified version. # # Default: All versions. # # Constraints: Must be one of the version returned from # DescribeClusterVersions. # @return [String] # # @!attribute [rw] node_type # The node type filter value. Specify this parameter to show only the # available offerings matching the specified node type. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeOrderableClusterOptions request exceed the value specified # in `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeOrderableClusterOptionsMessage AWS API Documentation # class DescribeOrderableClusterOptionsMessage < Struct.new( :cluster_version, :node_type, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribePartnersInputMessage # data as a hash: # # { # account_id: "PartnerIntegrationAccountId", # required # cluster_identifier: "PartnerIntegrationClusterIdentifier", # required # database_name: "PartnerIntegrationDatabaseName", # partner_name: "PartnerIntegrationPartnerName", # } # # @!attribute [rw] account_id # The Amazon Web Services account ID that owns the cluster. # @return [String] # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster whose partner integration is # being described. # @return [String] # # @!attribute [rw] database_name # The name of the database whose partner integration is being # described. If database name is not specified, then all databases in # the cluster are described. # @return [String] # # @!attribute [rw] partner_name # The name of the partner that is being described. If partner name is # not specified, then all partner integrations are described. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribePartnersInputMessage AWS API Documentation # class DescribePartnersInputMessage < Struct.new( :account_id, :cluster_identifier, :database_name, :partner_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] partner_integration_info_list # A list of partner integrations. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribePartnersOutputMessage AWS API Documentation # class DescribePartnersOutputMessage < Struct.new( :partner_integration_info_list) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeReservedNodeExchangeStatusInputMessage # data as a hash: # # { # reserved_node_id: "String", # reserved_node_exchange_request_id: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] reserved_node_id # The identifier of the source reserved node in a reserved-node # exchange request. # @return [String] # # @!attribute [rw] reserved_node_exchange_request_id # The identifier of the reserved-node exchange request. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `Marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # @return [Integer] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeReservedNodeExchangeStatus` request. If this parameter is # specified, the response includes only records beyond the marker, up # to the value specified by the `MaxRecords` parameter. You can # retrieve the next set of response records by providing the returned # marker value in the `Marker` parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeReservedNodeExchangeStatusInputMessage AWS API Documentation # class DescribeReservedNodeExchangeStatusInputMessage < Struct.new( :reserved_node_id, :reserved_node_exchange_request_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] reserved_node_exchange_status_details # The details of the reserved-node exchange request, including the # status, request time, source reserved-node identifier, and # additional details. # @return [Array] # # @!attribute [rw] marker # A pagination token provided by a previous # `DescribeReservedNodeExchangeStatus` request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeReservedNodeExchangeStatusOutputMessage AWS API Documentation # class DescribeReservedNodeExchangeStatusOutputMessage < Struct.new( :reserved_node_exchange_status_details, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeReservedNodeOfferingsMessage # data as a hash: # # { # reserved_node_offering_id: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] reserved_node_offering_id # The unique identifier for the offering. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeReservedNodeOfferings request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeReservedNodeOfferingsMessage AWS API Documentation # class DescribeReservedNodeOfferingsMessage < Struct.new( :reserved_node_offering_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeReservedNodesMessage # data as a hash: # # { # reserved_node_id: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] reserved_node_id # Identifier for the node reservation. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeReservedNodes # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeReservedNodesMessage AWS API Documentation # class DescribeReservedNodesMessage < Struct.new( :reserved_node_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeResizeMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The unique identifier of a cluster whose resize progress you are # requesting. This parameter is case-sensitive. # # By default, resize operations for all clusters defined for an Amazon # Web Services account are returned. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeResizeMessage AWS API Documentation # class DescribeResizeMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeScheduledActionsMessage # data as a hash: # # { # scheduled_action_name: "String", # target_action_type: "ResizeCluster", # accepts ResizeCluster, PauseCluster, ResumeCluster # start_time: Time.now, # end_time: Time.now, # active: false, # filters: [ # { # name: "cluster-identifier", # required, accepts cluster-identifier, iam-role # values: ["String"], # required # }, # ], # marker: "String", # max_records: 1, # } # # @!attribute [rw] scheduled_action_name # The name of the scheduled action to retrieve. # @return [String] # # @!attribute [rw] target_action_type # The type of the scheduled actions to retrieve. # @return [String] # # @!attribute [rw] start_time # The start time in UTC of the scheduled actions to retrieve. Only # active scheduled actions that have invocations after this time are # retrieved. # @return [Time] # # @!attribute [rw] end_time # The end time in UTC of the scheduled action to retrieve. Only active # scheduled actions that have invocations before this time are # retrieved. # @return [Time] # # @!attribute [rw] active # If true, retrieve only active scheduled actions. If false, retrieve # only disabled scheduled actions. # @return [Boolean] # # @!attribute [rw] filters # List of scheduled action filters. # @return [Array] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # DescribeScheduledActions request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeScheduledActionsMessage AWS API Documentation # class DescribeScheduledActionsMessage < Struct.new( :scheduled_action_name, :target_action_type, :start_time, :end_time, :active, :filters, :marker, :max_records) SENSITIVE = [] include Aws::Structure end # The result of the `DescribeSnapshotCopyGrants` action. # # @note When making an API call, you may pass DescribeSnapshotCopyGrantsMessage # data as a hash: # # { # snapshot_copy_grant_name: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] snapshot_copy_grant_name # The name of the snapshot copy grant. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a # `DescribeSnapshotCopyGrant` request exceed the value specified in # `MaxRecords`, Amazon Web Services returns a value in the `Marker` # field of the response. You can retrieve the next set of response # records by providing the returned marker value in the `Marker` # parameter and retrying the request. # # Constraints: You can specify either the **SnapshotCopyGrantName** # parameter or the **Marker** parameter, but not both. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching # resources that are associated with the specified key or keys. For # example, suppose that you have resources tagged with keys called # `owner` and `environment`. If you specify both of these tag keys in # the request, Amazon Redshift returns a response with all resources # that have either or both of these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # resources that are associated with the specified value or values. # For example, suppose that you have resources tagged with values # called `admin` and `test`. If you specify both of these tag values # in the request, Amazon Redshift returns a response with all # resources that have either or both of these tag values associated # with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeSnapshotCopyGrantsMessage AWS API Documentation # class DescribeSnapshotCopyGrantsMessage < Struct.new( :snapshot_copy_grant_name, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeSnapshotSchedulesMessage # data as a hash: # # { # cluster_identifier: "String", # schedule_identifier: "String", # tag_keys: ["String"], # tag_values: ["String"], # marker: "String", # max_records: 1, # } # # @!attribute [rw] cluster_identifier # The unique identifier for the cluster whose snapshot schedules you # want to view. # @return [String] # # @!attribute [rw] schedule_identifier # A unique identifier for a snapshot schedule. # @return [String] # # @!attribute [rw] tag_keys # The key value for a snapshot schedule tag. # @return [Array] # # @!attribute [rw] tag_values # The value corresponding to the key of the snapshot schedule tag. # @return [Array] # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] max_records # The maximum number or response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned `marker` value. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeSnapshotSchedulesMessage AWS API Documentation # class DescribeSnapshotSchedulesMessage < Struct.new( :cluster_identifier, :schedule_identifier, :tag_keys, :tag_values, :marker, :max_records) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot_schedules # A list of SnapshotSchedules. # @return [Array] # # @!attribute [rw] marker # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeSnapshotSchedulesOutputMessage AWS API Documentation # class DescribeSnapshotSchedulesOutputMessage < Struct.new( :snapshot_schedules, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTableRestoreStatusMessage # data as a hash: # # { # cluster_identifier: "String", # table_restore_request_id: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] cluster_identifier # The Amazon Redshift cluster that the table is being restored to. # @return [String] # # @!attribute [rw] table_restore_request_id # The identifier of the table restore request to return status for. If # you don't specify a `TableRestoreRequestId` value, then # `DescribeTableRestoreStatus` returns the status of all in-progress # table restore requests. # @return [String] # # @!attribute [rw] max_records # The maximum number of records to include in the response. If more # records exist than the specified `MaxRecords` value, a pagination # token called a marker is included in the response so that the # remaining results can be retrieved. # @return [Integer] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeTableRestoreStatus` request. If this parameter is # specified, the response includes only records beyond the marker, up # to the value specified by the `MaxRecords` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeTableRestoreStatusMessage AWS API Documentation # class DescribeTableRestoreStatusMessage < Struct.new( :cluster_identifier, :table_restore_request_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeTagsMessage # data as a hash: # # { # resource_name: "String", # resource_type: "String", # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] resource_name # The Amazon Resource Name (ARN) for which you want to describe the # tag or tags. For example, # `arn:aws:redshift:us-east-2:123456789:cluster:t1`. # @return [String] # # @!attribute [rw] resource_type # The type of resource with which you want to view tags. Valid # resource types are: # # * Cluster # # * CIDR/IP # # * EC2 security group # # * Snapshot # # * Cluster security group # # * Subnet group # # * HSM connection # # * HSM certificate # # * Parameter group # # * Snapshot copy grant # # For more information about Amazon Redshift resource types and # constructing ARNs, go to [Specifying Policy Elements: Actions, # Effects, Resources, and Principals][1] in the Amazon Redshift # Cluster Management Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-overview.html#redshift-iam-access-control-specify-actions # @return [String] # # @!attribute [rw] max_records # The maximum number or response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned `marker` value. # @return [Integer] # # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching # resources that are associated with the specified key or keys. For # example, suppose that you have resources tagged with keys called # `owner` and `environment`. If you specify both of these tag keys in # the request, Amazon Redshift returns a response with all resources # that have either or both of these tag keys associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # resources that are associated with the specified value or values. # For example, suppose that you have resources tagged with values # called `admin` and `test`. If you specify both of these tag values # in the request, Amazon Redshift returns a response with all # resources that have either or both of these tag values associated # with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeTagsMessage AWS API Documentation # class DescribeTagsMessage < Struct.new( :resource_name, :resource_type, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DescribeUsageLimitsMessage # data as a hash: # # { # usage_limit_id: "String", # cluster_identifier: "String", # feature_type: "spectrum", # accepts spectrum, concurrency-scaling, cross-region-datasharing # max_records: 1, # marker: "String", # tag_keys: ["String"], # tag_values: ["String"], # } # # @!attribute [rw] usage_limit_id # The identifier of the usage limit to describe. # @return [String] # # @!attribute [rw] cluster_identifier # The identifier of the cluster for which you want to describe usage # limits. # @return [String] # # @!attribute [rw] feature_type # The feature type for which you want to describe usage limits. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # # Default: `100` # # Constraints: minimum 20, maximum 100. # @return [Integer] # # @!attribute [rw] marker # An optional parameter that specifies the starting point to return a # set of response records. When the results of a DescribeUsageLimits # request exceed the value specified in `MaxRecords`, Amazon Web # Services returns a value in the `Marker` field of the response. You # can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @!attribute [rw] tag_keys # A tag key or keys for which you want to return all matching usage # limit objects that are associated with the specified key or keys. # For example, suppose that you have parameter groups that are tagged # with keys called `owner` and `environment`. If you specify both of # these tag keys in the request, Amazon Redshift returns a response # with the usage limit objects have either or both of these tag keys # associated with them. # @return [Array] # # @!attribute [rw] tag_values # A tag value or values for which you want to return all matching # usage limit objects that are associated with the specified tag value # or values. For example, suppose that you have parameter groups that # are tagged with values called `admin` and `test`. If you specify # both of these tag values in the request, Amazon Redshift returns a # response with the usage limit objects that have either or both of # these tag values associated with them. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeUsageLimitsMessage AWS API Documentation # class DescribeUsageLimitsMessage < Struct.new( :usage_limit_id, :cluster_identifier, :feature_type, :max_records, :marker, :tag_keys, :tag_values) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DisableLoggingMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster on which logging is to be stopped. # # Example: `examplecluster` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DisableLoggingMessage AWS API Documentation # class DisableLoggingMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DisableSnapshotCopyMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The unique identifier of the source cluster that you want to disable # copying of snapshots to a destination region. # # Constraints: Must be the valid name of an existing cluster that has # cross-region snapshot copy enabled. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DisableSnapshotCopyMessage AWS API Documentation # class DisableSnapshotCopyMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DisableSnapshotCopyResult AWS API Documentation # class DisableSnapshotCopyResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass DisassociateDataShareConsumerMessage # data as a hash: # # { # data_share_arn: "String", # required # disassociate_entire_account: false, # consumer_arn: "String", # consumer_region: "String", # } # # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare to remove # association for. # @return [String] # # @!attribute [rw] disassociate_entire_account # A value that specifies whether association for the datashare is # removed from the entire account. # @return [Boolean] # # @!attribute [rw] consumer_arn # The Amazon Resource Name (ARN) of the consumer that association for # the datashare is removed from. # @return [String] # # @!attribute [rw] consumer_region # From a datashare consumer account, removes association of a # datashare from all the existing and future namespaces in the # specified Amazon Web Services Region. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DisassociateDataShareConsumerMessage AWS API Documentation # class DisassociateDataShareConsumerMessage < Struct.new( :data_share_arn, :disassociate_entire_account, :consumer_arn, :consumer_region) SENSITIVE = [] include Aws::Structure end # Describes an Amazon EC2 security group. # # @!attribute [rw] status # The status of the EC2 security group. # @return [String] # # @!attribute [rw] ec2_security_group_name # The name of the EC2 Security Group. # @return [String] # # @!attribute [rw] ec2_security_group_owner_id # The Amazon Web Services account ID of the owner of the EC2 security # group specified in the `EC2SecurityGroupName` field. # @return [String] # # @!attribute [rw] tags # The list of tags for the EC2 security group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EC2SecurityGroup AWS API Documentation # class EC2SecurityGroup < Struct.new( :status, :ec2_security_group_name, :ec2_security_group_owner_id, :tags) SENSITIVE = [] include Aws::Structure end # Describes the status of the elastic IP (EIP) address. # # @!attribute [rw] elastic_ip # The elastic IP (EIP) address for the cluster. # @return [String] # # @!attribute [rw] status # The status of the elastic IP (EIP) address. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ElasticIpStatus AWS API Documentation # class ElasticIpStatus < Struct.new( :elastic_ip, :status) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass EnableLoggingMessage # data as a hash: # # { # cluster_identifier: "String", # required # bucket_name: "String", # s3_key_prefix: "String", # log_destination_type: "s3", # accepts s3, cloudwatch # log_exports: ["String"], # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster on which logging is to be started. # # Example: `examplecluster` # @return [String] # # @!attribute [rw] bucket_name # The name of an existing S3 bucket where the log files are to be # stored. # # Constraints: # # * Must be in the same region as the cluster # # * The cluster must have read bucket and put object permissions # @return [String] # # @!attribute [rw] s3_key_prefix # The prefix applied to the log file names. # # Constraints: # # * Cannot exceed 512 characters # # * Cannot contain spaces( ), double quotes ("), single quotes ('), # a backslash (\\), or control characters. The hexadecimal codes for # invalid characters are: # # * x00 to x20 # # * x22 # # * x27 # # * x5c # # * x7f or larger # @return [String] # # @!attribute [rw] log_destination_type # The log destination type. An enum with possible values of `s3` and # `cloudwatch`. # @return [String] # # @!attribute [rw] log_exports # The collection of exported log types. Log types include the # connection log, user log and user activity log. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EnableLoggingMessage AWS API Documentation # class EnableLoggingMessage < Struct.new( :cluster_identifier, :bucket_name, :s3_key_prefix, :log_destination_type, :log_exports) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass EnableSnapshotCopyMessage # data as a hash: # # { # cluster_identifier: "String", # required # destination_region: "String", # required # retention_period: 1, # snapshot_copy_grant_name: "String", # manual_snapshot_retention_period: 1, # } # # @!attribute [rw] cluster_identifier # The unique identifier of the source cluster to copy snapshots from. # # Constraints: Must be the valid name of an existing cluster that does # not already have cross-region snapshot copy enabled. # @return [String] # # @!attribute [rw] destination_region # The destination Amazon Web Services Region that you want to copy # snapshots to. # # Constraints: Must be the name of a valid Amazon Web Services Region. # For more information, see [Regions and Endpoints][1] in the Amazon # Web Services General Reference. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region # @return [String] # # @!attribute [rw] retention_period # The number of days to retain automated snapshots in the destination # region after they are copied from the source region. # # Default: 7. # # Constraints: Must be at least 1 and no more than 35. # @return [Integer] # # @!attribute [rw] snapshot_copy_grant_name # The name of the snapshot copy grant to use when snapshots of an # Amazon Web Services KMS-encrypted cluster are copied to the # destination region. # @return [String] # # @!attribute [rw] manual_snapshot_retention_period # The number of days to retain newly copied snapshots in the # destination Amazon Web Services Region after they are copied from # the source Amazon Web Services Region. If the value is -1, the # manual snapshot is retained indefinitely. # # The value must be either -1 or an integer between 1 and 3,653. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EnableSnapshotCopyMessage AWS API Documentation # class EnableSnapshotCopyMessage < Struct.new( :cluster_identifier, :destination_region, :retention_period, :snapshot_copy_grant_name, :manual_snapshot_retention_period) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EnableSnapshotCopyResult AWS API Documentation # class EnableSnapshotCopyResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Describes a connection endpoint. # # @!attribute [rw] address # The DNS address of the Cluster. # @return [String] # # @!attribute [rw] port # The port that the database engine is listening on. # @return [Integer] # # @!attribute [rw] vpc_endpoints # Describes a connection endpoint. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Endpoint AWS API Documentation # class Endpoint < Struct.new( :address, :port, :vpc_endpoints) SENSITIVE = [] include Aws::Structure end # Describes a Redshift-managed VPC endpoint. # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster associated with the endpoint. # @return [String] # # @!attribute [rw] resource_owner # The Amazon Web Services account ID of the owner of the cluster. # @return [String] # # @!attribute [rw] subnet_group_name # The subnet group name where Amazon Redshift chooses to deploy the # endpoint. # @return [String] # # @!attribute [rw] endpoint_status # The status of the endpoint. # @return [String] # # @!attribute [rw] endpoint_name # The name of the endpoint. # @return [String] # # @!attribute [rw] endpoint_create_time # The time (UTC) that the endpoint was created. # @return [Time] # # @!attribute [rw] port # The port number on which the cluster accepts incoming connections. # @return [Integer] # # @!attribute [rw] address # The DNS address of the endpoint. # @return [String] # # @!attribute [rw] vpc_security_groups # The security groups associated with the endpoint. # @return [Array] # # @!attribute [rw] vpc_endpoint # The connection endpoint for connecting to an Amazon Redshift cluster # through the proxy. # @return [Types::VpcEndpoint] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAccess AWS API Documentation # class EndpointAccess < Struct.new( :cluster_identifier, :resource_owner, :subnet_group_name, :endpoint_status, :endpoint_name, :endpoint_create_time, :port, :address, :vpc_security_groups, :vpc_endpoint) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] endpoint_access_list # The list of endpoints with access to the cluster. # @return [Array] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeEndpointAccess` request. If this parameter is specified, # the response includes only records beyond the marker, up to the # value specified by the `MaxRecords` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAccessList AWS API Documentation # class EndpointAccessList < Struct.new( :endpoint_access_list, :marker) SENSITIVE = [] include Aws::Structure end # The account already has a Redshift-managed VPC endpoint with the given # identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAlreadyExistsFault AWS API Documentation # class EndpointAlreadyExistsFault < Aws::EmptyStructure; end # Describes an endpoint authorization for authorizing Redshift-managed # VPC endpoint access to a cluster across Amazon Web Services accounts. # # @!attribute [rw] grantor # The Amazon Web Services account ID of the cluster owner. # @return [String] # # @!attribute [rw] grantee # The Amazon Web Services account ID of the grantee of the cluster. # @return [String] # # @!attribute [rw] cluster_identifier # The cluster identifier. # @return [String] # # @!attribute [rw] authorize_time # The time (UTC) when the authorization was created. # @return [Time] # # @!attribute [rw] cluster_status # The status of the cluster. # @return [String] # # @!attribute [rw] status # The status of the authorization action. # @return [String] # # @!attribute [rw] allowed_all_vp_cs # Indicates whether all VPCs in the grantee account are allowed access # to the cluster. # @return [Boolean] # # @!attribute [rw] allowed_vp_cs # The VPCs allowed access to the cluster. # @return [Array] # # @!attribute [rw] endpoint_count # The number of Redshift-managed VPC endpoints created for the # authorization. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAuthorization AWS API Documentation # class EndpointAuthorization < Struct.new( :grantor, :grantee, :cluster_identifier, :authorize_time, :cluster_status, :status, :allowed_all_vp_cs, :allowed_vp_cs, :endpoint_count) SENSITIVE = [] include Aws::Structure end # The authorization already exists for this endpoint. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAuthorizationAlreadyExistsFault AWS API Documentation # class EndpointAuthorizationAlreadyExistsFault < Aws::EmptyStructure; end # @!attribute [rw] endpoint_authorization_list # The authorizations to an endpoint. # @return [Array] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `DescribeEndpointAuthorization` request. If this parameter is # specified, the response includes only records beyond the marker, up # to the value specified by the `MaxRecords` parameter. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAuthorizationList AWS API Documentation # class EndpointAuthorizationList < Struct.new( :endpoint_authorization_list, :marker) SENSITIVE = [] include Aws::Structure end # The authorization for this endpoint can't be found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAuthorizationNotFoundFault AWS API Documentation # class EndpointAuthorizationNotFoundFault < Aws::EmptyStructure; end # The number of endpoint authorizations per cluster has exceeded its # limit. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointAuthorizationsPerClusterLimitExceededFault AWS API Documentation # class EndpointAuthorizationsPerClusterLimitExceededFault < Aws::EmptyStructure; end # The endpoint name doesn't refer to an existing endpoint. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointNotFoundFault AWS API Documentation # class EndpointNotFoundFault < Aws::EmptyStructure; end # The number of Redshift-managed VPC endpoints per authorization has # exceeded its limit. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointsPerAuthorizationLimitExceededFault AWS API Documentation # class EndpointsPerAuthorizationLimitExceededFault < Aws::EmptyStructure; end # The number of Redshift-managed VPC endpoints per cluster has exceeded # its limit. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EndpointsPerClusterLimitExceededFault AWS API Documentation # class EndpointsPerClusterLimitExceededFault < Aws::EmptyStructure; end # Describes an event. # # @!attribute [rw] source_identifier # The identifier for the source of the event. # @return [String] # # @!attribute [rw] source_type # The source type for this event. # @return [String] # # @!attribute [rw] message # The text of this event. # @return [String] # # @!attribute [rw] event_categories # A list of the event categories. # # Values: Configuration, Management, Monitoring, Security, Pending # @return [Array] # # @!attribute [rw] severity # The severity of the event. # # Values: ERROR, INFO # @return [String] # # @!attribute [rw] date # The date and time of the event. # @return [Time] # # @!attribute [rw] event_id # The identifier of the event. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Event AWS API Documentation # class Event < Struct.new( :source_identifier, :source_type, :message, :event_categories, :severity, :date, :event_id) SENSITIVE = [] include Aws::Structure end # Describes event categories. # # @!attribute [rw] source_type # The source type, such as cluster or cluster-snapshot, that the # returned categories belong to. # @return [String] # # @!attribute [rw] events # The events in the event category. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventCategoriesMap AWS API Documentation # class EventCategoriesMap < Struct.new( :source_type, :events) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] event_categories_map_list # A list of event categories descriptions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventCategoriesMessage AWS API Documentation # class EventCategoriesMessage < Struct.new( :event_categories_map_list) SENSITIVE = [] include Aws::Structure end # Describes event information. # # @!attribute [rw] event_id # The identifier of an Amazon Redshift event. # @return [String] # # @!attribute [rw] event_categories # The category of an Amazon Redshift event. # @return [Array] # # @!attribute [rw] event_description # The description of an Amazon Redshift event. # @return [String] # # @!attribute [rw] severity # The severity of the event. # # Values: ERROR, INFO # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventInfoMap AWS API Documentation # class EventInfoMap < Struct.new( :event_id, :event_categories, :event_description, :severity) SENSITIVE = [] include Aws::Structure end # Describes event subscriptions. # # @!attribute [rw] customer_aws_id # The Amazon Web Services account associated with the Amazon Redshift # event notification subscription. # @return [String] # # @!attribute [rw] cust_subscription_id # The name of the Amazon Redshift event notification subscription. # @return [String] # # @!attribute [rw] sns_topic_arn # The Amazon Resource Name (ARN) of the Amazon SNS topic used by the # event notification subscription. # @return [String] # # @!attribute [rw] status # 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. # @return [String] # # @!attribute [rw] subscription_creation_time # The date and time the Amazon Redshift event notification # subscription was created. # @return [Time] # # @!attribute [rw] source_type # The source type of the events returned by the Amazon Redshift event # notification, such as cluster, cluster-snapshot, # cluster-parameter-group, cluster-security-group, or # scheduled-action. # @return [String] # # @!attribute [rw] source_ids_list # A list of the sources that publish events to the Amazon Redshift # event notification subscription. # @return [Array] # # @!attribute [rw] event_categories_list # The list of Amazon Redshift event categories specified in the event # notification subscription. # # Values: Configuration, Management, Monitoring, Security, Pending # @return [Array] # # @!attribute [rw] severity # The event severity specified in the Amazon Redshift event # notification subscription. # # Values: ERROR, INFO # @return [String] # # @!attribute [rw] enabled # A boolean value indicating whether the subscription is enabled; # `true` indicates that the subscription is enabled. # @return [Boolean] # # @!attribute [rw] tags # The list of tags for the event subscription. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventSubscription AWS API Documentation # class EventSubscription < Struct.new( :customer_aws_id, :cust_subscription_id, :sns_topic_arn, :status, :subscription_creation_time, :source_type, :source_ids_list, :event_categories_list, :severity, :enabled, :tags) SENSITIVE = [] include Aws::Structure end # 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][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventSubscriptionQuotaExceededFault AWS API Documentation # class EventSubscriptionQuotaExceededFault < Aws::EmptyStructure; end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] event_subscriptions_list # A list of event subscriptions. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventSubscriptionsMessage AWS API Documentation # class EventSubscriptionsMessage < Struct.new( :marker, :event_subscriptions_list) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] events # A list of `Event` instances. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/EventsMessage AWS API Documentation # class EventsMessage < Struct.new( :marker, :events) SENSITIVE = [] include Aws::Structure end # The request parameters to get cluster credentials. # # @note When making an API call, you may pass GetClusterCredentialsMessage # data as a hash: # # { # db_user: "String", # required # db_name: "String", # cluster_identifier: "String", # required # duration_seconds: 1, # auto_create: false, # db_groups: ["String"], # } # # @!attribute [rw] db_user # The name of a database user. If a user name matching `DbUser` exists # in the database, the temporary user credentials have the same # permissions as the existing user. If `DbUser` doesn't exist in the # database and `Autocreate` is `True`, a new user is created using the # value for `DbUser` with PUBLIC permissions. If a database user # matching the value for `DbUser` doesn't exist and `Autocreate` is # `False`, then the command succeeds but the connection attempt will # fail because the user doesn't exist in the database. # # For more information, see [CREATE USER][1] in the Amazon Redshift # Database Developer Guide. # # Constraints: # # * Must be 1 to 64 alphanumeric characters or hyphens. The user name # can't be `PUBLIC`. # # * Must contain only lowercase letters, numbers, underscore, plus # sign, period (dot), at symbol (@), or hyphen. # # * First character must be a letter. # # * Must not contain a colon ( : ) or slash ( / ). # # * Cannot be a reserved word. A list of reserved words can be found # in [Reserved Words][2] in the Amazon Redshift Database Developer # Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html # [2]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] db_name # The name of a database that `DbUser` is authorized to log on to. If # `DbName` is not specified, `DbUser` can log on to any existing # database. # # Constraints: # # * Must be 1 to 64 alphanumeric characters or hyphens # # * Must contain only lowercase letters, numbers, underscore, plus # sign, period (dot), at symbol (@), or hyphen. # # * First character must be a letter. # # * Must not contain a colon ( : ) or slash ( / ). # # * Cannot be a reserved word. A list of reserved words can be found # in [Reserved Words][1] in the Amazon Redshift Database Developer # Guide. # # # # [1]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [String] # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster that contains the database for # which you are requesting credentials. This parameter is case # sensitive. # @return [String] # # @!attribute [rw] duration_seconds # The number of seconds until the returned temporary password expires. # # Constraint: minimum 900, maximum 3600. # # Default: 900 # @return [Integer] # # @!attribute [rw] auto_create # Create a database user with the name specified for the user named in # `DbUser` if one does not exist. # @return [Boolean] # # @!attribute [rw] db_groups # A list of the names of existing database groups that the user named # in `DbUser` will join for the current session, in addition to any # group memberships for an existing user. If not specified, a new user # is added only to PUBLIC. # # Database group name constraints # # * Must be 1 to 64 alphanumeric characters or hyphens # # * Must contain only lowercase letters, numbers, underscore, plus # sign, period (dot), at symbol (@), or hyphen. # # * First character must be a letter. # # * Must not contain a colon ( : ) or slash ( / ). # # * Cannot be a reserved word. A list of reserved words can be found # in [Reserved Words][1] in the Amazon Redshift Database Developer # Guide. # # # # [1]: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetClusterCredentialsMessage AWS API Documentation # class GetClusterCredentialsMessage < Struct.new( :db_user, :db_name, :cluster_identifier, :duration_seconds, :auto_create, :db_groups) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetClusterCredentialsWithIAMMessage # data as a hash: # # { # db_name: "String", # cluster_identifier: "String", # required # duration_seconds: 1, # } # # @!attribute [rw] db_name # The name of the database for which you are requesting credentials. # If the database name is specified, the IAM policy must allow access # to the resource `dbname` for the specified database name. If the # database name is not specified, access to all databases is allowed. # @return [String] # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster that contains the database for # which you are requesting credentials. # @return [String] # # @!attribute [rw] duration_seconds # The number of seconds until the returned temporary password expires. # # Range: 900-3600. Default: 900. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetClusterCredentialsWithIAMMessage AWS API Documentation # class GetClusterCredentialsWithIAMMessage < Struct.new( :db_name, :cluster_identifier, :duration_seconds) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetReservedNodeExchangeConfigurationOptionsInputMessage # data as a hash: # # { # action_type: "restore-cluster", # required, accepts restore-cluster, resize-cluster # cluster_identifier: "String", # snapshot_identifier: "String", # max_records: 1, # marker: "String", # } # # @!attribute [rw] action_type # The action type of the reserved-node configuration. The action type # can be an exchange initiated from either a snapshot or a resize. # @return [String] # # @!attribute [rw] cluster_identifier # The identifier for the cluster that is the source for a # reserved-node exchange. # @return [String] # # @!attribute [rw] snapshot_identifier # The identifier for the snapshot that is the source for the # reserved-node exchange. # @return [String] # # @!attribute [rw] max_records # The maximum number of response records to return in each call. If # the number of remaining response records exceeds the specified # `MaxRecords` value, a value is returned in a `Marker` field of the # response. You can retrieve the next set of records by retrying the # command with the returned marker value. # @return [Integer] # # @!attribute [rw] marker # An optional pagination token provided by a previous # `GetReservedNodeExchangeConfigurationOptions` request. If this # parameter is specified, the response includes only records beyond # the marker, up to the value specified by the `MaxRecords` parameter. # You can retrieve the next set of response records by providing the # returned marker value in the `Marker` parameter and retrying the # request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetReservedNodeExchangeConfigurationOptionsInputMessage AWS API Documentation # class GetReservedNodeExchangeConfigurationOptionsInputMessage < Struct.new( :action_type, :cluster_identifier, :snapshot_identifier, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] marker # A pagination token provided by a previous # `GetReservedNodeExchangeConfigurationOptions` request. # @return [String] # # @!attribute [rw] reserved_node_configuration_option_list # the configuration options for the reserved-node exchange. These # options include information about the source reserved node and # target reserved node. Details include the node type, the price, the # node count, and the offering type. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetReservedNodeExchangeConfigurationOptionsOutputMessage AWS API Documentation # class GetReservedNodeExchangeConfigurationOptionsOutputMessage < Struct.new( :marker, :reserved_node_configuration_option_list) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass GetReservedNodeExchangeOfferingsInputMessage # data as a hash: # # { # reserved_node_id: "String", # required # max_records: 1, # marker: "String", # } # # @!attribute [rw] reserved_node_id # A string representing the node identifier for the DC1 Reserved Node # to be exchanged. # @return [String] # # @!attribute [rw] max_records # An integer setting the maximum number of ReservedNodeOfferings to # retrieve. # @return [Integer] # # @!attribute [rw] marker # A value that indicates the starting point for the next set of # ReservedNodeOfferings. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetReservedNodeExchangeOfferingsInputMessage AWS API Documentation # class GetReservedNodeExchangeOfferingsInputMessage < Struct.new( :reserved_node_id, :max_records, :marker) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] marker # An optional parameter that specifies the starting point for # returning a set of response records. When the results of a # `GetReservedNodeExchangeOfferings` request exceed the value # specified in MaxRecords, Amazon Redshift returns a value in the # marker field of the response. You can retrieve the next set of # response records by providing the returned marker value in the # marker parameter and retrying the request. # @return [String] # # @!attribute [rw] reserved_node_offerings # Returns an array of ReservedNodeOffering objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/GetReservedNodeExchangeOfferingsOutputMessage AWS API Documentation # class GetReservedNodeExchangeOfferingsOutputMessage < Struct.new( :marker, :reserved_node_offerings) SENSITIVE = [] include Aws::Structure end # 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. # # @!attribute [rw] hsm_client_certificate_identifier # The identifier of the HSM client certificate. # @return [String] # # @!attribute [rw] hsm_client_certificate_public_key # The public key that the Amazon Redshift cluster will use to connect # to the HSM. You must register the public key in the HSM. # @return [String] # # @!attribute [rw] tags # The list of tags for the HSM client certificate. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmClientCertificate AWS API Documentation # class HsmClientCertificate < Struct.new( :hsm_client_certificate_identifier, :hsm_client_certificate_public_key, :tags) SENSITIVE = [] include Aws::Structure end # There is already an existing Amazon Redshift HSM client certificate # with the specified identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmClientCertificateAlreadyExistsFault AWS API Documentation # class HsmClientCertificateAlreadyExistsFault < Aws::EmptyStructure; end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] hsm_client_certificates # A list of the identifiers for one or more HSM client certificates # used by Amazon Redshift clusters to store and retrieve database # encryption keys in an HSM. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmClientCertificateMessage AWS API Documentation # class HsmClientCertificateMessage < Struct.new( :marker, :hsm_client_certificates) SENSITIVE = [] include Aws::Structure end # There is no Amazon Redshift HSM client certificate with the specified # identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmClientCertificateNotFoundFault AWS API Documentation # class HsmClientCertificateNotFoundFault < Aws::EmptyStructure; end # The quota for HSM client certificates has been reached. For # information about increasing your quota, go to [Limits in Amazon # Redshift][1] in the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmClientCertificateQuotaExceededFault AWS API Documentation # class HsmClientCertificateQuotaExceededFault < Aws::EmptyStructure; end # 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. # # @!attribute [rw] hsm_configuration_identifier # The name of the Amazon Redshift HSM configuration. # @return [String] # # @!attribute [rw] description # A text description of the HSM configuration. # @return [String] # # @!attribute [rw] hsm_ip_address # The IP address that the Amazon Redshift cluster must use to access # the HSM. # @return [String] # # @!attribute [rw] hsm_partition_name # The name of the partition in the HSM where the Amazon Redshift # clusters will store their database encryption keys. # @return [String] # # @!attribute [rw] tags # The list of tags for the HSM configuration. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmConfiguration AWS API Documentation # class HsmConfiguration < Struct.new( :hsm_configuration_identifier, :description, :hsm_ip_address, :hsm_partition_name, :tags) SENSITIVE = [] include Aws::Structure end # There is already an existing Amazon Redshift HSM configuration with # the specified identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmConfigurationAlreadyExistsFault AWS API Documentation # class HsmConfigurationAlreadyExistsFault < Aws::EmptyStructure; end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] hsm_configurations # A list of `HsmConfiguration` objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmConfigurationMessage AWS API Documentation # class HsmConfigurationMessage < Struct.new( :marker, :hsm_configurations) SENSITIVE = [] include Aws::Structure end # There is no Amazon Redshift HSM configuration with the specified # identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmConfigurationNotFoundFault AWS API Documentation # class HsmConfigurationNotFoundFault < Aws::EmptyStructure; end # The quota for HSM configurations has been reached. For information # about increasing your quota, go to [Limits in Amazon Redshift][1] in # the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmConfigurationQuotaExceededFault AWS API Documentation # class HsmConfigurationQuotaExceededFault < Aws::EmptyStructure; end # Describes the status of changes to HSM settings. # # @!attribute [rw] hsm_client_certificate_identifier # Specifies the name of the HSM client certificate the Amazon Redshift # cluster uses to retrieve the data encryption keys stored in an HSM. # @return [String] # # @!attribute [rw] hsm_configuration_identifier # 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. # @return [String] # # @!attribute [rw] status # Reports whether the Amazon Redshift cluster has finished applying # any HSM settings changes specified in a modify cluster command. # # Values: active, applying # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/HsmStatus AWS API Documentation # class HsmStatus < Struct.new( :hsm_client_certificate_identifier, :hsm_configuration_identifier, :status) SENSITIVE = [] include Aws::Structure end # Describes an IP range used in a security group. # # @!attribute [rw] status # The status of the IP range, for example, "authorized". # @return [String] # # @!attribute [rw] cidrip # The IP range in Classless Inter-Domain Routing (CIDR) notation. # @return [String] # # @!attribute [rw] tags # The list of tags for the IP range. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IPRange AWS API Documentation # class IPRange < Struct.new( :status, :cidrip, :tags) SENSITIVE = [] include Aws::Structure end # You have exceeded the allowed number of table restore requests. Wait # for your current table restore requests to complete before making a # new request. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InProgressTableRestoreQuotaExceededFault AWS API Documentation # class InProgressTableRestoreQuotaExceededFault < Aws::EmptyStructure; end # The specified options are incompatible. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/IncompatibleOrderableOptions AWS API Documentation # class IncompatibleOrderableOptions < Aws::EmptyStructure; end # The number of nodes specified exceeds the allotted capacity of the # cluster. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InsufficientClusterCapacityFault AWS API Documentation # class InsufficientClusterCapacityFault < Aws::EmptyStructure; end # The cluster does not have read bucket or put object permissions on the # S3 bucket specified when enabling logging. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InsufficientS3BucketPolicyFault AWS API Documentation # class InsufficientS3BucketPolicyFault < Aws::EmptyStructure; end # The authentication profile request is not valid. The profile name # can't be null or empty. The authentication profile API operation must # be available in the Amazon Web Services Region. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidAuthenticationProfileRequestFault AWS API Documentation # class InvalidAuthenticationProfileRequestFault < Aws::EmptyStructure; end # The status of the authorization is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidAuthorizationStateFault AWS API Documentation # class InvalidAuthorizationStateFault < Aws::EmptyStructure; end # 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. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterParameterGroupStateFault AWS API Documentation # class InvalidClusterParameterGroupStateFault < Aws::EmptyStructure; end # The state of the cluster security group is not `available`. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterSecurityGroupStateFault AWS API Documentation # class InvalidClusterSecurityGroupStateFault < Aws::EmptyStructure; end # The cluster snapshot schedule state is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterSnapshotScheduleStateFault AWS API Documentation # class InvalidClusterSnapshotScheduleStateFault < Aws::EmptyStructure; end # The specified cluster snapshot is not in the `available` state, or # other accounts are authorized to access the snapshot. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterSnapshotStateFault AWS API Documentation # class InvalidClusterSnapshotStateFault < Aws::EmptyStructure; end # The specified cluster is not in the `available` state. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterStateFault AWS API Documentation # class InvalidClusterStateFault < Aws::EmptyStructure; end # The cluster subnet group cannot be deleted because it is in use. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterSubnetGroupStateFault AWS API Documentation # class InvalidClusterSubnetGroupStateFault < Aws::EmptyStructure; end # The state of the subnet is invalid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterSubnetStateFault AWS API Documentation # class InvalidClusterSubnetStateFault < Aws::EmptyStructure; end # The provided cluster track name is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidClusterTrackFault AWS API Documentation # class InvalidClusterTrackFault < Aws::EmptyStructure; end # There is an error with the datashare. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidDataShareFault AWS API Documentation # class InvalidDataShareFault < Aws::EmptyStructure; end # The Elastic IP (EIP) is invalid or cannot be found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidElasticIpFault AWS API Documentation # class InvalidElasticIpFault < Aws::EmptyStructure; end # The status of the endpoint is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidEndpointStateFault AWS API Documentation # class InvalidEndpointStateFault < Aws::EmptyStructure; end # The specified HSM client certificate is not in the `available` state, # or it is still in use by one or more Amazon Redshift clusters. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidHsmClientCertificateStateFault AWS API Documentation # class InvalidHsmClientCertificateStateFault < Aws::EmptyStructure; end # The specified HSM configuration is not in the `available` state, or it # is still in use by one or more Amazon Redshift clusters. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidHsmConfigurationStateFault AWS API Documentation # class InvalidHsmConfigurationStateFault < Aws::EmptyStructure; end # The namespace isn't valid because the namespace doesn't exist. # Provide a valid namespace. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidNamespaceFault AWS API Documentation # class InvalidNamespaceFault < Aws::EmptyStructure; end # Indicates that the Reserved Node being exchanged is not in an active # state. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidReservedNodeStateFault AWS API Documentation # class InvalidReservedNodeStateFault < Aws::EmptyStructure; end # The restore is invalid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidRestoreFault AWS API Documentation # class InvalidRestoreFault < Aws::EmptyStructure; end # The retention period specified is either in the past or is not a valid # value. # # The value must be either -1 or an integer between 1 and 3,653. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidRetentionPeriodFault AWS API Documentation # class InvalidRetentionPeriodFault < Aws::EmptyStructure; end # The S3 bucket name is invalid. For more information about naming # rules, go to [Bucket Restrictions and Limitations][1] in the Amazon # Simple Storage Service (S3) Developer Guide. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidS3BucketNameFault AWS API Documentation # class InvalidS3BucketNameFault < Aws::EmptyStructure; end # The string specified for the logging S3 key prefix does not comply # with the documented constraints. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidS3KeyPrefixFault AWS API Documentation # class InvalidS3KeyPrefixFault < Aws::EmptyStructure; end # The schedule you submitted isn't valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidScheduleFault AWS API Documentation # class InvalidScheduleFault < Aws::EmptyStructure; end # The scheduled action is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidScheduledActionFault AWS API Documentation # class InvalidScheduledActionFault < Aws::EmptyStructure; end # The snapshot copy grant can't be deleted because it is used by one or # more clusters. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidSnapshotCopyGrantStateFault AWS API Documentation # class InvalidSnapshotCopyGrantStateFault < Aws::EmptyStructure; end # The requested subnet is not valid, or not all of the subnets are in # the same VPC. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidSubnet AWS API Documentation # class InvalidSubnet < Aws::EmptyStructure; end # The subscription request is invalid because it is a duplicate request. # This subscription request is already in progress. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidSubscriptionStateFault AWS API Documentation # class InvalidSubscriptionStateFault < Aws::EmptyStructure; end # The value specified for the `sourceDatabaseName`, `sourceSchemaName`, # or `sourceTableName` parameter, or a combination of these, doesn't # exist in the snapshot. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidTableRestoreArgumentFault AWS API Documentation # class InvalidTableRestoreArgumentFault < Aws::EmptyStructure; end # The tag is invalid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidTagFault AWS API Documentation # class InvalidTagFault < Aws::EmptyStructure; end # The usage limit is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidUsageLimitFault AWS API Documentation # class InvalidUsageLimitFault < Aws::EmptyStructure; end # The cluster subnet group does not cover all Availability Zones. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/InvalidVPCNetworkStateFault AWS API Documentation # class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end # The encryption key has exceeded its grant limit in Amazon Web Services # KMS. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/LimitExceededFault AWS API Documentation # class LimitExceededFault < Aws::EmptyStructure; end # Describes the status of logging for a cluster. # # @!attribute [rw] logging_enabled # `true` if logging is on, `false` if logging is off. # @return [Boolean] # # @!attribute [rw] bucket_name # The name of the S3 bucket where the log files are stored. # @return [String] # # @!attribute [rw] s3_key_prefix # The prefix applied to the log file names. # @return [String] # # @!attribute [rw] last_successful_delivery_time # The last time that logs were delivered. # @return [Time] # # @!attribute [rw] last_failure_time # The last time when logs failed to be delivered. # @return [Time] # # @!attribute [rw] last_failure_message # The message indicating that logs failed to be delivered. # @return [String] # # @!attribute [rw] log_destination_type # The log destination type. An enum with possible values of `s3` and # `cloudwatch`. # @return [String] # # @!attribute [rw] log_exports # The collection of exported log types. Log types include the # connection log, user log and user activity log. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/LoggingStatus AWS API Documentation # class LoggingStatus < Struct.new( :logging_enabled, :bucket_name, :s3_key_prefix, :last_successful_delivery_time, :last_failure_time, :last_failure_message, :log_destination_type, :log_exports) SENSITIVE = [] include Aws::Structure end # Defines a maintenance track that determines which Amazon Redshift # version to apply during a maintenance window. If the value for # `MaintenanceTrack` is `current`, the cluster is updated to the most # recently certified maintenance release. If the value is `trailing`, # the cluster is updated to the previously certified maintenance # release. # # @!attribute [rw] maintenance_track_name # The name of the maintenance track. Possible values are `current` and # `trailing`. # @return [String] # # @!attribute [rw] database_version # The version number for the cluster release. # @return [String] # # @!attribute [rw] update_targets # An array of UpdateTarget objects to update with the maintenance # track. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/MaintenanceTrack AWS API Documentation # class MaintenanceTrack < Struct.new( :maintenance_track_name, :database_version, :update_targets) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyAquaInputMessage # data as a hash: # # { # cluster_identifier: "String", # required # aqua_configuration_status: "enabled", # accepts enabled, disabled, auto # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster to be modified. # @return [String] # # @!attribute [rw] aqua_configuration_status # The new value of AQUA configuration status. Possible values include # the following. # # * enabled - Use AQUA if it is available for the current Amazon Web # Services Region and Amazon Redshift node type. # # * disabled - Don't use AQUA. # # * auto - Amazon Redshift determines whether to use AQUA. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAquaInputMessage AWS API Documentation # class ModifyAquaInputMessage < Struct.new( :cluster_identifier, :aqua_configuration_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] aqua_configuration # The updated AQUA configuration of the cluster. # @return [Types::AquaConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAquaOutputMessage AWS API Documentation # class ModifyAquaOutputMessage < Struct.new( :aqua_configuration) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyAuthenticationProfileMessage # data as a hash: # # { # authentication_profile_name: "AuthenticationProfileNameString", # required # authentication_profile_content: "String", # required # } # # @!attribute [rw] authentication_profile_name # The name of the authentication profile to replace. # @return [String] # # @!attribute [rw] authentication_profile_content # The new content of the authentication profile in JSON format. The # maximum length of the JSON string is determined by a quota for your # account. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAuthenticationProfileMessage AWS API Documentation # class ModifyAuthenticationProfileMessage < Struct.new( :authentication_profile_name, :authentication_profile_content) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] authentication_profile_name # The name of the authentication profile that was replaced. # @return [String] # # @!attribute [rw] authentication_profile_content # The updated content of the authentication profile in JSON format. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyAuthenticationProfileResult AWS API Documentation # class ModifyAuthenticationProfileResult < Struct.new( :authentication_profile_name, :authentication_profile_content) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterDbRevisionMessage # data as a hash: # # { # cluster_identifier: "String", # required # revision_target: "String", # required # } # # @!attribute [rw] cluster_identifier # The unique identifier of a cluster whose database revision you want # to modify. # # Example: `examplecluster` # @return [String] # # @!attribute [rw] revision_target # The identifier of the database revision. You can retrieve this value # from the response to the DescribeClusterDbRevisions request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterDbRevisionMessage AWS API Documentation # class ModifyClusterDbRevisionMessage < Struct.new( :cluster_identifier, :revision_target) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterDbRevisionResult AWS API Documentation # class ModifyClusterDbRevisionResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterIamRolesMessage # data as a hash: # # { # cluster_identifier: "String", # required # add_iam_roles: ["String"], # remove_iam_roles: ["String"], # default_iam_role_arn: "String", # } # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster for which you want to associate # or disassociate IAM roles. # @return [String] # # @!attribute [rw] add_iam_roles # Zero or more IAM roles to associate with the cluster. The roles must # be in their Amazon Resource Name (ARN) format. # @return [Array] # # @!attribute [rw] remove_iam_roles # Zero or more IAM roles in ARN format to disassociate from the # cluster. # @return [Array] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) for the IAM role that was set as # default for the cluster when the cluster was last modified. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterIamRolesMessage AWS API Documentation # class ModifyClusterIamRolesMessage < Struct.new( :cluster_identifier, :add_iam_roles, :remove_iam_roles, :default_iam_role_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterIamRolesResult AWS API Documentation # class ModifyClusterIamRolesResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterMaintenanceMessage # data as a hash: # # { # cluster_identifier: "String", # required # defer_maintenance: false, # defer_maintenance_identifier: "String", # defer_maintenance_start_time: Time.now, # defer_maintenance_end_time: Time.now, # defer_maintenance_duration: 1, # } # # @!attribute [rw] cluster_identifier # A unique identifier for the cluster. # @return [String] # # @!attribute [rw] defer_maintenance # A boolean indicating whether to enable the deferred maintenance # window. # @return [Boolean] # # @!attribute [rw] defer_maintenance_identifier # A unique identifier for the deferred maintenance window. # @return [String] # # @!attribute [rw] defer_maintenance_start_time # A timestamp indicating the start time for the deferred maintenance # window. # @return [Time] # # @!attribute [rw] defer_maintenance_end_time # A timestamp indicating end time for the deferred maintenance window. # If you specify an end time, you can't specify a duration. # @return [Time] # # @!attribute [rw] defer_maintenance_duration # An integer indicating the duration of the maintenance window in # days. If you specify a duration, you can't specify an end time. The # duration must be 45 days or less. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterMaintenanceMessage AWS API Documentation # class ModifyClusterMaintenanceMessage < Struct.new( :cluster_identifier, :defer_maintenance, :defer_maintenance_identifier, :defer_maintenance_start_time, :defer_maintenance_end_time, :defer_maintenance_duration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterMaintenanceResult AWS API Documentation # class ModifyClusterMaintenanceResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # cluster_type: "String", # node_type: "String", # number_of_nodes: 1, # cluster_security_groups: ["String"], # vpc_security_group_ids: ["String"], # master_user_password: "String", # cluster_parameter_group_name: "String", # automated_snapshot_retention_period: 1, # manual_snapshot_retention_period: 1, # preferred_maintenance_window: "String", # cluster_version: "String", # allow_version_upgrade: false, # hsm_client_certificate_identifier: "String", # hsm_configuration_identifier: "String", # new_cluster_identifier: "String", # publicly_accessible: false, # elastic_ip: "String", # enhanced_vpc_routing: false, # maintenance_track_name: "String", # encrypted: false, # kms_key_id: "String", # availability_zone_relocation: false, # availability_zone: "String", # port: 1, # } # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster to be modified. # # Example: `examplecluster` # @return [String] # # @!attribute [rw] cluster_type # The new cluster type. # # When you submit your cluster resize request, your existing cluster # goes into a read-only mode. After Amazon Redshift provisions a new # cluster based on your resize requirements, there will be outage for # a period while the old cluster is deleted and your connection is # switched to the new cluster. You can use DescribeResize to track the # progress of the resize request. # # Valid Values: ` multi-node | single-node ` # @return [String] # # @!attribute [rw] node_type # The new node type of the cluster. If you specify a new node type, # you must also specify the number of nodes parameter. # # For more information about resizing clusters, go to [Resizing # Clusters in Amazon Redshift][1] in the *Amazon Redshift Cluster # Management Guide*. # # Valid Values: `ds2.xlarge` \| `ds2.8xlarge` \| `dc1.large` \| # `dc1.8xlarge` \| `dc2.large` \| `dc2.8xlarge` \| `ra3.xlplus` \| # `ra3.4xlarge` \| `ra3.16xlarge` # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html # @return [String] # # @!attribute [rw] number_of_nodes # The new number of nodes of the cluster. If you specify a new number # of nodes, you must also specify the node type parameter. # # For more information about resizing clusters, go to [Resizing # Clusters in Amazon Redshift][1] in the *Amazon Redshift Cluster # Management Guide*. # # Valid Values: Integer greater than `0`. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html # @return [Integer] # # @!attribute [rw] cluster_security_groups # A list of cluster security groups to be authorized on this cluster. # This change is asynchronously applied as soon as possible. # # Security groups currently associated with the cluster, and not in # the list of groups to apply, will be revoked from the cluster. # # Constraints: # # * Must be 1 to 255 alphanumeric characters or hyphens # # * First character must be a letter # # * Cannot end with a hyphen or contain two consecutive hyphens # @return [Array] # # @!attribute [rw] vpc_security_group_ids # A list of virtual private cloud (VPC) security groups to be # associated with the cluster. This change is asynchronously applied # as soon as possible. # @return [Array] # # @!attribute [rw] master_user_password # The new password for the cluster admin user. This change is # asynchronously applied as soon as possible. Between the time of the # request and the completion of the request, the `MasterUserPassword` # element exists in the `PendingModifiedValues` element of the # operation response. # # Operations never return the password, so this operation provides a # way to regain access to the admin user account for a cluster if the # password is lost. # # # # Default: Uses existing setting. # # Constraints: # # * Must be between 8 and 64 characters in length. # # * Must contain at least one uppercase letter. # # * Must contain at least one lowercase letter. # # * Must contain one number. # # * Can be any printable ASCII character (ASCII code 33-126) except # `'` (single quote), `"` (double quote), ``, `/`, or `@`. # @return [String] # # @!attribute [rw] cluster_parameter_group_name # The name of the cluster parameter group to apply to this cluster. # This change is applied only after the cluster is rebooted. To reboot # a cluster use RebootCluster. # # Default: Uses existing setting. # # Constraints: The cluster parameter group must be in the same # parameter group family that matches the cluster version. # @return [String] # # @!attribute [rw] automated_snapshot_retention_period # The number of days that automated snapshots are retained. If the # value is 0, automated snapshots are disabled. Even if automated # snapshots are disabled, you can still create manual snapshots when # you want with CreateClusterSnapshot. # # If you decrease the automated snapshot retention period from its # current value, existing automated snapshots that fall outside of the # new retention period will be immediately deleted. # # You can't disable automated snapshots for RA3 node types. Set the # automated retention period from 1-35 days. # # Default: Uses existing setting. # # Constraints: Must be a value from 0 to 35. # @return [Integer] # # @!attribute [rw] manual_snapshot_retention_period # The default for number of days that a newly created manual snapshot # is retained. If the value is -1, the manual snapshot is retained # indefinitely. This value doesn't retroactively change the retention # periods of existing manual snapshots. # # The value must be either -1 or an integer between 1 and 3,653. # # The default value is -1. # @return [Integer] # # @!attribute [rw] preferred_maintenance_window # The weekly time range (in UTC) during which system maintenance can # occur, if necessary. If system maintenance is necessary during the # window, it may result in an outage. # # This maintenance window change is made immediately. If the new # maintenance window indicates the current time, there must be at # least 120 minutes between the current time and end of the window in # order to ensure that pending changes are applied. # # Default: Uses existing setting. # # Format: ddd:hh24:mi-ddd:hh24:mi, for example `wed:07:30-wed:08:00`. # # Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun # # Constraints: Must be at least 30 minutes. # @return [String] # # @!attribute [rw] cluster_version # The new version number of the Amazon Redshift engine to upgrade to. # # For major version upgrades, if a non-default cluster parameter group # is currently in use, a new cluster parameter group in the cluster # parameter group family for the new version must be specified. The # new cluster parameter group can be the default for that cluster # parameter group family. For more information about parameters and # parameter groups, go to [Amazon Redshift Parameter Groups][1] in the # *Amazon Redshift Cluster Management Guide*. # # Example: `1.0` # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html # @return [String] # # @!attribute [rw] allow_version_upgrade # If `true`, major version upgrades will be applied automatically to # the cluster during the maintenance window. # # Default: `false` # @return [Boolean] # # @!attribute [rw] hsm_client_certificate_identifier # Specifies the name of the HSM client certificate the Amazon Redshift # cluster uses to retrieve the data encryption keys stored in an HSM. # @return [String] # # @!attribute [rw] hsm_configuration_identifier # 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. # @return [String] # # @!attribute [rw] new_cluster_identifier # The new identifier for the cluster. # # Constraints: # # * Must contain from 1 to 63 alphanumeric characters or hyphens. # # * Alphabetic characters must be lowercase. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique for all clusters within an Amazon Web Services # account. # # Example: `examplecluster` # @return [String] # # @!attribute [rw] publicly_accessible # If `true`, the cluster can be accessed from a public network. Only # clusters in VPCs can be set to be publicly available. # @return [Boolean] # # @!attribute [rw] elastic_ip # The Elastic IP (EIP) address for the cluster. # # Constraints: The cluster must be provisioned in EC2-VPC and # publicly-accessible through an Internet gateway. For more # information about provisioning clusters in EC2-VPC, go to [Supported # Platforms to Launch Your Cluster][1] in the Amazon Redshift Cluster # Management Guide. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms # @return [String] # # @!attribute [rw] enhanced_vpc_routing # 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][1] in the Amazon Redshift Cluster Management # Guide. # # If this option is `true`, enhanced VPC routing is enabled. # # Default: false # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html # @return [Boolean] # # @!attribute [rw] maintenance_track_name # The name for the maintenance track that you want to assign for the # cluster. This name change is asynchronous. The new track name stays # in the `PendingModifiedValues` for the cluster until the next # maintenance window. When the maintenance track changes, the cluster # is switched to the latest cluster release available for the # maintenance track. At this point, the maintenance track name is # applied. # @return [String] # # @!attribute [rw] encrypted # Indicates whether the cluster is encrypted. If the value is # encrypted (true) and you provide a value for the `KmsKeyId` # parameter, we encrypt the cluster with the provided `KmsKeyId`. If # you don't provide a `KmsKeyId`, we encrypt with the default key. # # If the value is not encrypted (false), then the cluster is # decrypted. # @return [Boolean] # # @!attribute [rw] kms_key_id # The Key Management Service (KMS) key ID of the encryption key that # you want to use to encrypt data in the cluster. # @return [String] # # @!attribute [rw] availability_zone_relocation # The option to enable relocation for an Amazon Redshift cluster # between Availability Zones after the cluster modification is # complete. # @return [Boolean] # # @!attribute [rw] availability_zone # The option to initiate relocation for an Amazon Redshift cluster to # the target Availability Zone. # @return [String] # # @!attribute [rw] port # The option to change the port of an Amazon Redshift cluster. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterMessage AWS API Documentation # class ModifyClusterMessage < Struct.new( :cluster_identifier, :cluster_type, :node_type, :number_of_nodes, :cluster_security_groups, :vpc_security_group_ids, :master_user_password, :cluster_parameter_group_name, :automated_snapshot_retention_period, :manual_snapshot_retention_period, :preferred_maintenance_window, :cluster_version, :allow_version_upgrade, :hsm_client_certificate_identifier, :hsm_configuration_identifier, :new_cluster_identifier, :publicly_accessible, :elastic_ip, :enhanced_vpc_routing, :maintenance_track_name, :encrypted, :kms_key_id, :availability_zone_relocation, :availability_zone, :port) SENSITIVE = [] include Aws::Structure end # Describes a modify cluster parameter group operation. # # @note When making an API call, you may pass ModifyClusterParameterGroupMessage # data as a hash: # # { # parameter_group_name: "String", # required # parameters: [ # required # { # parameter_name: "String", # parameter_value: "String", # description: "String", # source: "String", # data_type: "String", # allowed_values: "String", # apply_type: "static", # accepts static, dynamic # is_modifiable: false, # minimum_engine_version: "String", # }, # ], # } # # @!attribute [rw] parameter_group_name # The name of the parameter group to be modified. # @return [String] # # @!attribute [rw] parameters # An array of parameters to be modified. A maximum of 20 parameters # can be modified in a single request. # # For each parameter to be modified, you must supply at least the # parameter name and parameter value; other name-value pairs of the # parameter are optional. # # For the workload management (WLM) configuration, you must supply all # the name-value pairs in the wlm\_json\_configuration parameter. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterParameterGroupMessage AWS API Documentation # class ModifyClusterParameterGroupMessage < Struct.new( :parameter_group_name, :parameters) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterResult AWS API Documentation # class ModifyClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterSnapshotMessage # data as a hash: # # { # snapshot_identifier: "String", # required # manual_snapshot_retention_period: 1, # force: false, # } # # @!attribute [rw] snapshot_identifier # The identifier of the snapshot whose setting you want to modify. # @return [String] # # @!attribute [rw] manual_snapshot_retention_period # The number of days that a manual snapshot is retained. If the value # is -1, the manual snapshot is retained indefinitely. # # If the manual snapshot falls outside of the new retention period, # you can specify the force option to immediately delete the snapshot. # # The value must be either -1 or an integer between 1 and 3,653. # @return [Integer] # # @!attribute [rw] force # A Boolean option to override an exception if the retention period # has already passed. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterSnapshotMessage AWS API Documentation # class ModifyClusterSnapshotMessage < Struct.new( :snapshot_identifier, :manual_snapshot_retention_period, :force) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterSnapshotResult AWS API Documentation # class ModifyClusterSnapshotResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterSnapshotScheduleMessage # data as a hash: # # { # cluster_identifier: "String", # required # schedule_identifier: "String", # disassociate_schedule: false, # } # # @!attribute [rw] cluster_identifier # A unique identifier for the cluster whose snapshot schedule you want # to modify. # @return [String] # # @!attribute [rw] schedule_identifier # A unique alphanumeric identifier for the schedule that you want to # associate with the cluster. # @return [String] # # @!attribute [rw] disassociate_schedule # A boolean to indicate whether to remove the assoiciation between the # cluster and the schedule. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterSnapshotScheduleMessage AWS API Documentation # class ModifyClusterSnapshotScheduleMessage < Struct.new( :cluster_identifier, :schedule_identifier, :disassociate_schedule) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyClusterSubnetGroupMessage # data as a hash: # # { # cluster_subnet_group_name: "String", # required # description: "String", # subnet_ids: ["String"], # required # } # # @!attribute [rw] cluster_subnet_group_name # The name of the subnet group to be modified. # @return [String] # # @!attribute [rw] description # A text description of the subnet group to be modified. # @return [String] # # @!attribute [rw] subnet_ids # An array of VPC subnet IDs. A maximum of 20 subnets can be modified # in a single request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterSubnetGroupMessage AWS API Documentation # class ModifyClusterSubnetGroupMessage < Struct.new( :cluster_subnet_group_name, :description, :subnet_ids) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_subnet_group # Describes a subnet group. # @return [Types::ClusterSubnetGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyClusterSubnetGroupResult AWS API Documentation # class ModifyClusterSubnetGroupResult < Struct.new( :cluster_subnet_group) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyEndpointAccessMessage # data as a hash: # # { # endpoint_name: "String", # required # vpc_security_group_ids: ["String"], # } # # @!attribute [rw] endpoint_name # The endpoint to be modified. # @return [String] # # @!attribute [rw] vpc_security_group_ids # The complete list of VPC security groups associated with the # endpoint after the endpoint is modified. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyEndpointAccessMessage AWS API Documentation # class ModifyEndpointAccessMessage < Struct.new( :endpoint_name, :vpc_security_group_ids) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyEventSubscriptionMessage # data as a hash: # # { # subscription_name: "String", # required # sns_topic_arn: "String", # source_type: "String", # source_ids: ["String"], # event_categories: ["String"], # severity: "String", # enabled: false, # } # # @!attribute [rw] subscription_name # The name of the modified Amazon Redshift event notification # subscription. # @return [String] # # @!attribute [rw] sns_topic_arn # The Amazon Resource Name (ARN) of the SNS topic to be used by the # event notification subscription. # @return [String] # # @!attribute [rw] source_type # The type of source that will be generating the events. For example, # if you want to be notified of events generated by a cluster, you # would set this parameter to cluster. If this value is not specified, # events are returned for all Amazon Redshift objects in your Amazon # Web Services account. You must specify a source type in order to # specify source IDs. # # Valid values: cluster, cluster-parameter-group, # cluster-security-group, cluster-snapshot, and scheduled-action. # @return [String] # # @!attribute [rw] source_ids # A list of one or more identifiers of Amazon Redshift source objects. # All of the objects must be of the same type as was specified in the # source type parameter. The event subscription will return only # events generated by the specified objects. If not specified, then # events are returned for all objects within the source type # specified. # # Example: my-cluster-1, my-cluster-2 # # Example: my-snapshot-20131010 # @return [Array] # # @!attribute [rw] event_categories # Specifies the Amazon Redshift event categories to be published by # the event notification subscription. # # Values: configuration, management, monitoring, security, pending # @return [Array] # # @!attribute [rw] severity # Specifies the Amazon Redshift event severity to be published by the # event notification subscription. # # Values: ERROR, INFO # @return [String] # # @!attribute [rw] enabled # A Boolean value indicating if the subscription is enabled. `true` # indicates the subscription is enabled # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyEventSubscriptionMessage AWS API Documentation # class ModifyEventSubscriptionMessage < Struct.new( :subscription_name, :sns_topic_arn, :source_type, :source_ids, :event_categories, :severity, :enabled) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] event_subscription # Describes event subscriptions. # @return [Types::EventSubscription] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyEventSubscriptionResult AWS API Documentation # class ModifyEventSubscriptionResult < Struct.new( :event_subscription) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyScheduledActionMessage # data as a hash: # # { # scheduled_action_name: "String", # required # target_action: { # resize_cluster: { # cluster_identifier: "String", # required # cluster_type: "String", # node_type: "String", # number_of_nodes: 1, # classic: false, # reserved_node_id: "String", # target_reserved_node_offering_id: "String", # }, # pause_cluster: { # cluster_identifier: "String", # required # }, # resume_cluster: { # cluster_identifier: "String", # required # }, # }, # schedule: "String", # iam_role: "String", # scheduled_action_description: "String", # start_time: Time.now, # end_time: Time.now, # enable: false, # } # # @!attribute [rw] scheduled_action_name # The name of the scheduled action to modify. # @return [String] # # @!attribute [rw] target_action # A modified JSON format of the scheduled action. For more information # about this parameter, see ScheduledAction. # @return [Types::ScheduledActionType] # # @!attribute [rw] schedule # A modified schedule in either `at( )` or `cron( )` format. For more # information about this parameter, see ScheduledAction. # @return [String] # # @!attribute [rw] iam_role # A different IAM role to assume to run the target action. For more # information about this parameter, see ScheduledAction. # @return [String] # # @!attribute [rw] scheduled_action_description # A modified description of the scheduled action. # @return [String] # # @!attribute [rw] start_time # A modified start time of the scheduled action. For more information # about this parameter, see ScheduledAction. # @return [Time] # # @!attribute [rw] end_time # A modified end time of the scheduled action. For more information # about this parameter, see ScheduledAction. # @return [Time] # # @!attribute [rw] enable # A modified enable flag of the scheduled action. If true, the # scheduled action is active. If false, the scheduled action is # disabled. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyScheduledActionMessage AWS API Documentation # class ModifyScheduledActionMessage < Struct.new( :scheduled_action_name, :target_action, :schedule, :iam_role, :scheduled_action_description, :start_time, :end_time, :enable) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifySnapshotCopyRetentionPeriodMessage # data as a hash: # # { # cluster_identifier: "String", # required # retention_period: 1, # required # manual: false, # } # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster for which you want to change # the retention period for either automated or manual snapshots that # are copied to a destination Amazon Web Services Region. # # Constraints: Must be the valid name of an existing cluster that has # cross-region snapshot copy enabled. # @return [String] # # @!attribute [rw] retention_period # The number of days to retain automated snapshots in the destination # Amazon Web Services Region after they are copied from the source # Amazon Web Services Region. # # By default, this only changes the retention period of copied # automated snapshots. # # If you decrease the retention period for automated snapshots that # are copied to a destination Amazon Web Services Region, Amazon # Redshift deletes any existing automated snapshots that were copied # to the destination Amazon Web Services Region and that fall outside # of the new retention period. # # Constraints: Must be at least 1 and no more than 35 for automated # snapshots. # # If you specify the `manual` option, only newly copied manual # snapshots will have the new retention period. # # If you specify the value of -1 newly copied manual snapshots are # retained indefinitely. # # Constraints: The number of days must be either -1 or an integer # between 1 and 3,653 for manual snapshots. # @return [Integer] # # @!attribute [rw] manual # Indicates whether to apply the snapshot retention period to newly # copied manual snapshots instead of automated snapshots. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifySnapshotCopyRetentionPeriodMessage AWS API Documentation # class ModifySnapshotCopyRetentionPeriodMessage < Struct.new( :cluster_identifier, :retention_period, :manual) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifySnapshotCopyRetentionPeriodResult AWS API Documentation # class ModifySnapshotCopyRetentionPeriodResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifySnapshotScheduleMessage # data as a hash: # # { # schedule_identifier: "String", # required # schedule_definitions: ["String"], # required # } # # @!attribute [rw] schedule_identifier # A unique alphanumeric identifier of the schedule to modify. # @return [String] # # @!attribute [rw] schedule_definitions # An updated list of schedule definitions. A schedule definition is # made up of schedule expressions, for example, "cron(30 12 *)" or # "rate(12 hours)". # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifySnapshotScheduleMessage AWS API Documentation # class ModifySnapshotScheduleMessage < Struct.new( :schedule_identifier, :schedule_definitions) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ModifyUsageLimitMessage # data as a hash: # # { # usage_limit_id: "String", # required # amount: 1, # breach_action: "log", # accepts log, emit-metric, disable # } # # @!attribute [rw] usage_limit_id # The identifier of the usage limit to modify. # @return [String] # # @!attribute [rw] amount # The new limit amount. For more information about this parameter, see # UsageLimit. # @return [Integer] # # @!attribute [rw] breach_action # The new action that Amazon Redshift takes when the limit is reached. # For more information about this parameter, see UsageLimit. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ModifyUsageLimitMessage AWS API Documentation # class ModifyUsageLimitMessage < Struct.new( :usage_limit_id, :amount, :breach_action) SENSITIVE = [] include Aws::Structure end # Describes a network interface. # # @!attribute [rw] network_interface_id # The network interface identifier. # @return [String] # # @!attribute [rw] subnet_id # The subnet identifier. # @return [String] # # @!attribute [rw] private_ip_address # The IPv4 address of the network interface within the subnet. # @return [String] # # @!attribute [rw] availability_zone # The Availability Zone. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NetworkInterface AWS API Documentation # class NetworkInterface < Struct.new( :network_interface_id, :subnet_id, :private_ip_address, :availability_zone) SENSITIVE = [] include Aws::Structure end # A list of node configurations. # # @!attribute [rw] node_type # The node type, such as, "ds2.8xlarge". # @return [String] # # @!attribute [rw] number_of_nodes # The number of nodes. # @return [Integer] # # @!attribute [rw] estimated_disk_utilization_percent # The estimated disk utilizaton percentage. # @return [Float] # # @!attribute [rw] mode # The category of the node configuration recommendation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NodeConfigurationOption AWS API Documentation # class NodeConfigurationOption < Struct.new( :node_type, :number_of_nodes, :estimated_disk_utilization_percent, :mode) SENSITIVE = [] include Aws::Structure end # A set of elements to filter the returned node configurations. # # @note When making an API call, you may pass NodeConfigurationOptionsFilter # data as a hash: # # { # name: "NodeType", # accepts NodeType, NumberOfNodes, EstimatedDiskUtilizationPercent, Mode # operator: "eq", # accepts eq, lt, gt, le, ge, in, between # values: ["String"], # } # # @!attribute [rw] name # The name of the element to filter. # @return [String] # # @!attribute [rw] operator # The filter operator. If filter Name is NodeType only the 'in' # operator is supported. Provide one value to evaluate for 'eq', # 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate # for 'between'. Provide a list of values for 'in'. # @return [String] # # @!attribute [rw] values # List of values. Compare Name using Operator to Values. If filter # Name is NumberOfNodes, then values can range from 0 to 200. If # filter Name is EstimatedDiskUtilizationPercent, then values can # range from 0 to 100. For example, filter NumberOfNodes (name) GT # (operator) 3 (values). # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NodeConfigurationOptionsFilter AWS API Documentation # class NodeConfigurationOptionsFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] node_configuration_option_list # A list of valid node configurations. # @return [Array] # # @!attribute [rw] marker # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NodeConfigurationOptionsMessage AWS API Documentation # class NodeConfigurationOptionsMessage < Struct.new( :node_configuration_option_list, :marker) SENSITIVE = [] include Aws::Structure end # The operation would exceed the number of nodes allowed for a cluster. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NumberOfNodesPerClusterLimitExceededFault AWS API Documentation # class NumberOfNodesPerClusterLimitExceededFault < Aws::EmptyStructure; end # The operation would exceed the number of nodes allotted to the # account. For information about increasing your quota, go to [Limits in # Amazon Redshift][1] in the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/NumberOfNodesQuotaExceededFault AWS API Documentation # class NumberOfNodesQuotaExceededFault < Aws::EmptyStructure; end # Describes an orderable cluster option. # # @!attribute [rw] cluster_version # The version of the orderable cluster. # @return [String] # # @!attribute [rw] cluster_type # The cluster type, for example `multi-node`. # @return [String] # # @!attribute [rw] node_type # The node type for the orderable cluster. # @return [String] # # @!attribute [rw] availability_zones # A list of availability zones for the orderable cluster. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/OrderableClusterOption AWS API Documentation # class OrderableClusterOption < Struct.new( :cluster_version, :cluster_type, :node_type, :availability_zones) SENSITIVE = [] include Aws::Structure end # Contains the output from the DescribeOrderableClusterOptions action. # # @!attribute [rw] orderable_cluster_options # An `OrderableClusterOption` structure containing information about # orderable options for the cluster. # @return [Array] # # @!attribute [rw] marker # 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. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/OrderableClusterOptionsMessage AWS API Documentation # class OrderableClusterOptionsMessage < Struct.new( :orderable_cluster_options, :marker) SENSITIVE = [] include Aws::Structure end # Describes a parameter in a cluster parameter group. # # @note When making an API call, you may pass Parameter # data as a hash: # # { # parameter_name: "String", # parameter_value: "String", # description: "String", # source: "String", # data_type: "String", # allowed_values: "String", # apply_type: "static", # accepts static, dynamic # is_modifiable: false, # minimum_engine_version: "String", # } # # @!attribute [rw] parameter_name # The name of the parameter. # @return [String] # # @!attribute [rw] parameter_value # The value of the parameter. If `ParameterName` is # `wlm_json_configuration`, then the maximum size of `ParameterValue` # is 8000 characters. # @return [String] # # @!attribute [rw] description # A description of the parameter. # @return [String] # # @!attribute [rw] source # The source of the parameter value, such as "engine-default" or # "user". # @return [String] # # @!attribute [rw] data_type # The data type of the parameter. # @return [String] # # @!attribute [rw] allowed_values # The valid range of values for the parameter. # @return [String] # # @!attribute [rw] apply_type # Specifies how to apply the WLM configuration parameter. Some # properties can be applied dynamically, while other properties # require that any associated clusters be rebooted for the # configuration changes to be applied. For more information about # parameters and parameter groups, go to [Amazon Redshift Parameter # Groups][1] in the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html # @return [String] # # @!attribute [rw] is_modifiable # If `true`, the parameter can be modified. Some parameters have # security or operational implications that prevent them from being # changed. # @return [Boolean] # # @!attribute [rw] minimum_engine_version # The earliest engine version to which the parameter can apply. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Parameter AWS API Documentation # class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :data_type, :allowed_values, :apply_type, :is_modifiable, :minimum_engine_version) SENSITIVE = [] include Aws::Structure end # Describes a partner integration. # # @!attribute [rw] database_name # The name of the database that receives data from a partner. # @return [String] # # @!attribute [rw] partner_name # The name of the partner. # @return [String] # # @!attribute [rw] status # The partner integration status. # @return [String] # # @!attribute [rw] status_message # The status message provided by the partner. # @return [String] # # @!attribute [rw] created_at # The date (UTC) that the partner integration was created. # @return [Time] # # @!attribute [rw] updated_at # The date (UTC) that the partner integration status was last updated # by the partner. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PartnerIntegrationInfo AWS API Documentation # class PartnerIntegrationInfo < Struct.new( :database_name, :partner_name, :status, :status_message, :created_at, :updated_at) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PartnerIntegrationInputMessage # data as a hash: # # { # account_id: "PartnerIntegrationAccountId", # required # cluster_identifier: "PartnerIntegrationClusterIdentifier", # required # database_name: "PartnerIntegrationDatabaseName", # required # partner_name: "PartnerIntegrationPartnerName", # required # } # # @!attribute [rw] account_id # The Amazon Web Services account ID that owns the cluster. # @return [String] # # @!attribute [rw] cluster_identifier # The cluster identifier of the cluster that receives data from the # partner. # @return [String] # # @!attribute [rw] database_name # The name of the database that receives data from the partner. # @return [String] # # @!attribute [rw] partner_name # The name of the partner that is authorized to send data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PartnerIntegrationInputMessage AWS API Documentation # class PartnerIntegrationInputMessage < Struct.new( :account_id, :cluster_identifier, :database_name, :partner_name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] database_name # The name of the database that receives data from the partner. # @return [String] # # @!attribute [rw] partner_name # The name of the partner that is authorized to send data. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PartnerIntegrationOutputMessage AWS API Documentation # class PartnerIntegrationOutputMessage < Struct.new( :database_name, :partner_name) SENSITIVE = [] include Aws::Structure end # The name of the partner was not found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PartnerNotFoundFault AWS API Documentation # class PartnerNotFoundFault < Aws::EmptyStructure; end # Describes a pause cluster operation. For example, a scheduled action # to run the `PauseCluster` API operation. # # @note When making an API call, you may pass PauseClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster to be paused. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PauseClusterMessage AWS API Documentation # class PauseClusterMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PauseClusterResult AWS API Documentation # class PauseClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # 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. # # @!attribute [rw] master_user_password # The pending or in-progress change of the admin user password for the # cluster. # @return [String] # # @!attribute [rw] node_type # The pending or in-progress change of the cluster's node type. # @return [String] # # @!attribute [rw] number_of_nodes # The pending or in-progress change of the number of nodes in the # cluster. # @return [Integer] # # @!attribute [rw] cluster_type # The pending or in-progress change of the cluster type. # @return [String] # # @!attribute [rw] cluster_version # The pending or in-progress change of the service version. # @return [String] # # @!attribute [rw] automated_snapshot_retention_period # The pending or in-progress change of the automated snapshot # retention period. # @return [Integer] # # @!attribute [rw] cluster_identifier # The pending or in-progress change of the new identifier for the # cluster. # @return [String] # # @!attribute [rw] publicly_accessible # The pending or in-progress change of the ability to connect to the # cluster from the public network. # @return [Boolean] # # @!attribute [rw] enhanced_vpc_routing # 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][1] in the Amazon Redshift Cluster Management # Guide. # # If this option is `true`, enhanced VPC routing is enabled. # # Default: false # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html # @return [Boolean] # # @!attribute [rw] maintenance_track_name # The name of the maintenance track that the cluster will change to # during the next maintenance window. # @return [String] # # @!attribute [rw] encryption_type # The encryption type for a cluster. Possible values are: KMS and # None. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PendingModifiedValues AWS API Documentation # class PendingModifiedValues < Struct.new( :master_user_password, :node_type, :number_of_nodes, :cluster_type, :cluster_version, :automated_snapshot_retention_period, :cluster_identifier, :publicly_accessible, :enhanced_vpc_routing, :maintenance_track_name, :encryption_type) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass PurchaseReservedNodeOfferingMessage # data as a hash: # # { # reserved_node_offering_id: "String", # required # node_count: 1, # } # # @!attribute [rw] reserved_node_offering_id # The unique identifier of the reserved node offering you want to # purchase. # @return [String] # # @!attribute [rw] node_count # The number of reserved nodes that you want to purchase. # # Default: `1` # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PurchaseReservedNodeOfferingMessage AWS API Documentation # class PurchaseReservedNodeOfferingMessage < Struct.new( :reserved_node_offering_id, :node_count) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] reserved_node # Describes a reserved node. You can call the # DescribeReservedNodeOfferings API to obtain the available reserved # node offerings. # @return [Types::ReservedNode] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/PurchaseReservedNodeOfferingResult AWS API Documentation # class PurchaseReservedNodeOfferingResult < Struct.new( :reserved_node) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RebootClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The cluster identifier. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RebootClusterMessage AWS API Documentation # class RebootClusterMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RebootClusterResult AWS API Documentation # class RebootClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Describes a recurring charge. # # @!attribute [rw] recurring_charge_amount # The amount charged per the period of time specified by the recurring # charge frequency. # @return [Float] # # @!attribute [rw] recurring_charge_frequency # The frequency at which the recurring charge amount is applied. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RecurringCharge AWS API Documentation # class RecurringCharge < Struct.new( :recurring_charge_amount, :recurring_charge_frequency) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RejectDataShareMessage # data as a hash: # # { # data_share_arn: "String", # required # } # # @!attribute [rw] data_share_arn # The Amazon Resource Name (ARN) of the datashare to reject. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RejectDataShareMessage AWS API Documentation # class RejectDataShareMessage < Struct.new( :data_share_arn) SENSITIVE = [] include Aws::Structure end # Describes a reserved node. You can call the # DescribeReservedNodeOfferings API to obtain the available reserved # node offerings. # # @!attribute [rw] reserved_node_id # The unique identifier for the reservation. # @return [String] # # @!attribute [rw] reserved_node_offering_id # The identifier for the reserved node offering. # @return [String] # # @!attribute [rw] node_type # The node type of the reserved node. # @return [String] # # @!attribute [rw] start_time # The time the reservation started. You purchase a reserved node # offering for a duration. This is the start time of that duration. # @return [Time] # # @!attribute [rw] duration # The duration of the node reservation in seconds. # @return [Integer] # # @!attribute [rw] fixed_price # The fixed cost Amazon Redshift charges you for this reserved node. # @return [Float] # # @!attribute [rw] usage_price # The hourly rate Amazon Redshift charges you for this reserved node. # @return [Float] # # @!attribute [rw] currency_code # The currency code for the reserved cluster. # @return [String] # # @!attribute [rw] node_count # The number of reserved compute nodes. # @return [Integer] # # @!attribute [rw] state # 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. # # * retired-The reserved node is no longer available. # # * exchanging-The owner is exchanging the reserved node for another # reserved node. # @return [String] # # @!attribute [rw] offering_type # The anticipated utilization of the reserved node, as defined in the # reserved node offering. # @return [String] # # @!attribute [rw] recurring_charges # The recurring charges for the reserved node. # @return [Array] # # @!attribute [rw] reserved_node_offering_type # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNode AWS API Documentation # class ReservedNode < Struct.new( :reserved_node_id, :reserved_node_offering_id, :node_type, :start_time, :duration, :fixed_price, :usage_price, :currency_code, :node_count, :state, :offering_type, :recurring_charges, :reserved_node_offering_type) SENSITIVE = [] include Aws::Structure end # User already has a reservation with the given identifier. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeAlreadyExistsFault AWS API Documentation # class ReservedNodeAlreadyExistsFault < Aws::EmptyStructure; end # Indicates that the reserved node has already been exchanged. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeAlreadyMigratedFault AWS API Documentation # class ReservedNodeAlreadyMigratedFault < Aws::EmptyStructure; end # Details for a reserved-node exchange. Examples include the node type # for a reserved node, the price for a node, the node's state, and # other details. # # @!attribute [rw] source_reserved_node # Describes a reserved node. You can call the # DescribeReservedNodeOfferings API to obtain the available reserved # node offerings. # @return [Types::ReservedNode] # # @!attribute [rw] target_reserved_node_count # The target reserved-node count. # @return [Integer] # # @!attribute [rw] target_reserved_node_offering # Describes a reserved node offering. # @return [Types::ReservedNodeOffering] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeConfigurationOption AWS API Documentation # class ReservedNodeConfigurationOption < Struct.new( :source_reserved_node, :target_reserved_node_count, :target_reserved_node_offering) SENSITIVE = [] include Aws::Structure end # The reserved-node exchange status wasn't found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeExchangeNotFoundFault AWS API Documentation # class ReservedNodeExchangeNotFoundFault < Aws::EmptyStructure; end # Reserved-node status details, such as the source reserved-node # identifier, the target reserved-node identifier, the node type, the # node count, and other details. # # @!attribute [rw] reserved_node_exchange_request_id # The identifier of the reserved-node exchange request. # @return [String] # # @!attribute [rw] status # The status of the reserved-node exchange request. Statuses include # in-progress and requested. # @return [String] # # @!attribute [rw] request_time # A date and time that indicate when the reserved-node exchange was # requested. # @return [Time] # # @!attribute [rw] source_reserved_node_id # The identifier of the source reserved node. # @return [String] # # @!attribute [rw] source_reserved_node_type # The source reserved-node type, for example ds2.xlarge. # @return [String] # # @!attribute [rw] source_reserved_node_count # The source reserved-node count in the cluster. # @return [Integer] # # @!attribute [rw] target_reserved_node_offering_id # The identifier of the target reserved node offering. # @return [String] # # @!attribute [rw] target_reserved_node_type # The node type of the target reserved node, for example ra3.4xlarge. # @return [String] # # @!attribute [rw] target_reserved_node_count # The count of target reserved nodes in the cluster. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeExchangeStatus AWS API Documentation # class ReservedNodeExchangeStatus < Struct.new( :reserved_node_exchange_request_id, :status, :request_time, :source_reserved_node_id, :source_reserved_node_type, :source_reserved_node_count, :target_reserved_node_offering_id, :target_reserved_node_type, :target_reserved_node_count) SENSITIVE = [] include Aws::Structure end # The specified reserved compute node not found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeNotFoundFault AWS API Documentation # class ReservedNodeNotFoundFault < Aws::EmptyStructure; end # Describes a reserved node offering. # # @!attribute [rw] reserved_node_offering_id # The offering identifier. # @return [String] # # @!attribute [rw] node_type # The node type offered by the reserved node offering. # @return [String] # # @!attribute [rw] duration # The duration, in seconds, for which the offering will reserve the # node. # @return [Integer] # # @!attribute [rw] fixed_price # The upfront fixed charge you will pay to purchase the specific # reserved node offering. # @return [Float] # # @!attribute [rw] usage_price # The rate you are charged for each hour the cluster that is using the # offering is running. # @return [Float] # # @!attribute [rw] currency_code # The currency code for the compute nodes offering. # @return [String] # # @!attribute [rw] offering_type # The anticipated utilization of the reserved node, as defined in the # reserved node offering. # @return [String] # # @!attribute [rw] recurring_charges # 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. # @return [Array] # # @!attribute [rw] reserved_node_offering_type # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeOffering AWS API Documentation # class ReservedNodeOffering < Struct.new( :reserved_node_offering_id, :node_type, :duration, :fixed_price, :usage_price, :currency_code, :offering_type, :recurring_charges, :reserved_node_offering_type) SENSITIVE = [] include Aws::Structure end # Specified offering does not exist. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeOfferingNotFoundFault AWS API Documentation # class ReservedNodeOfferingNotFoundFault < Aws::EmptyStructure; end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] reserved_node_offerings # A list of `ReservedNodeOffering` objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeOfferingsMessage AWS API Documentation # class ReservedNodeOfferingsMessage < Struct.new( :marker, :reserved_node_offerings) SENSITIVE = [] include Aws::Structure end # Request would exceed the user's compute node quota. For information # about increasing your quota, go to [Limits in Amazon Redshift][1] in # the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodeQuotaExceededFault AWS API Documentation # class ReservedNodeQuotaExceededFault < Aws::EmptyStructure; end # @!attribute [rw] marker # 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. # @return [String] # # @!attribute [rw] reserved_nodes # The list of `ReservedNode` objects. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ReservedNodesMessage AWS API Documentation # class ReservedNodesMessage < Struct.new( :marker, :reserved_nodes) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass ResetClusterParameterGroupMessage # data as a hash: # # { # parameter_group_name: "String", # required # reset_all_parameters: false, # parameters: [ # { # parameter_name: "String", # parameter_value: "String", # description: "String", # source: "String", # data_type: "String", # allowed_values: "String", # apply_type: "static", # accepts static, dynamic # is_modifiable: false, # minimum_engine_version: "String", # }, # ], # } # # @!attribute [rw] parameter_group_name # The name of the cluster parameter group to be reset. # @return [String] # # @!attribute [rw] reset_all_parameters # If `true`, all parameters in the specified parameter group will be # reset to their default values. # # Default: `true` # @return [Boolean] # # @!attribute [rw] parameters # An array of names of parameters to be reset. If *ResetAllParameters* # option is not used, then at least one parameter name must be # supplied. # # Constraints: A maximum of 20 parameters can be reset in a single # request. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResetClusterParameterGroupMessage AWS API Documentation # class ResetClusterParameterGroupMessage < Struct.new( :parameter_group_name, :reset_all_parameters, :parameters) SENSITIVE = [] include Aws::Structure end # Describes a resize cluster operation. For example, a scheduled action # to run the `ResizeCluster` API operation. # # @note When making an API call, you may pass ResizeClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # cluster_type: "String", # node_type: "String", # number_of_nodes: 1, # classic: false, # reserved_node_id: "String", # target_reserved_node_offering_id: "String", # } # # @!attribute [rw] cluster_identifier # The unique identifier for the cluster to resize. # @return [String] # # @!attribute [rw] cluster_type # The new cluster type for the specified cluster. # @return [String] # # @!attribute [rw] node_type # The new node type for the nodes you are adding. If not specified, # the cluster's current node type is used. # @return [String] # # @!attribute [rw] number_of_nodes # The new number of nodes for the cluster. If not specified, the # cluster's current number of nodes is used. # @return [Integer] # # @!attribute [rw] classic # A boolean value indicating whether the resize operation is using the # classic resize process. If you don't provide this parameter or set # the value to `false`, the resize type is elastic. # @return [Boolean] # # @!attribute [rw] reserved_node_id # The identifier of the reserved node. # @return [String] # # @!attribute [rw] target_reserved_node_offering_id # The identifier of the target reserved node offering. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeClusterMessage AWS API Documentation # class ResizeClusterMessage < Struct.new( :cluster_identifier, :cluster_type, :node_type, :number_of_nodes, :classic, :reserved_node_id, :target_reserved_node_offering_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeClusterResult AWS API Documentation # class ResizeClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Describes a resize operation. # # @!attribute [rw] resize_type # Returns the value `ClassicResize`. # @return [String] # # @!attribute [rw] allow_cancel_resize # A boolean value indicating if the resize operation can be cancelled. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeInfo AWS API Documentation # class ResizeInfo < Struct.new( :resize_type, :allow_cancel_resize) SENSITIVE = [] include Aws::Structure end # A resize operation for the specified cluster is not found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeNotFoundFault AWS API Documentation # class ResizeNotFoundFault < Aws::EmptyStructure; end # Describes the result of a cluster resize operation. # # @!attribute [rw] target_node_type # The node type that the cluster will have after the resize operation # is complete. # @return [String] # # @!attribute [rw] target_number_of_nodes # The number of nodes that the cluster will have after the resize # operation is complete. # @return [Integer] # # @!attribute [rw] target_cluster_type # The cluster type after the resize operation is complete. # # Valid Values: `multi-node` \| `single-node` # @return [String] # # @!attribute [rw] status # The status of the resize operation. # # Valid Values: `NONE` \| `IN_PROGRESS` \| `FAILED` \| `SUCCEEDED` \| # `CANCELLING` # @return [String] # # @!attribute [rw] import_tables_completed # The names of tables that have been completely imported . # # Valid Values: List of table names. # @return [Array] # # @!attribute [rw] import_tables_in_progress # The names of tables that are being currently imported. # # Valid Values: List of table names. # @return [Array] # # @!attribute [rw] import_tables_not_started # The names of tables that have not been yet imported. # # Valid Values: List of table names # @return [Array] # # @!attribute [rw] avg_resize_rate_in_mega_bytes_per_second # The average rate of the resize operation over the last few minutes, # measured in megabytes per second. After the resize operation # completes, this value shows the average rate of the entire resize # operation. # @return [Float] # # @!attribute [rw] total_resize_data_in_mega_bytes # The estimated total amount of data, in megabytes, on the cluster # before the resize operation began. # @return [Integer] # # @!attribute [rw] progress_in_mega_bytes # While the resize operation is in progress, this value shows the # current amount of data, in megabytes, that has been processed so # far. When the resize operation is complete, this value shows the # total amount of data, in megabytes, on the cluster, which may be # more or less than TotalResizeDataInMegaBytes (the estimated total # amount of data before resize). # @return [Integer] # # @!attribute [rw] elapsed_time_in_seconds # The amount of seconds that have elapsed since the resize operation # began. After the resize operation completes, this value shows the # total actual time, in seconds, for the resize operation. # @return [Integer] # # @!attribute [rw] estimated_time_to_completion_in_seconds # The estimated time remaining, in seconds, until the resize operation # is complete. This value is calculated based on the average resize # rate and the estimated amount of data remaining to be processed. # Once the resize operation is complete, this value will be 0. # @return [Integer] # # @!attribute [rw] resize_type # An enum with possible values of `ClassicResize` and `ElasticResize`. # These values describe the type of resize operation being performed. # @return [String] # # @!attribute [rw] message # An optional string to provide additional details about the resize # action. # @return [String] # # @!attribute [rw] target_encryption_type # The type of encryption for the cluster after the resize is complete. # # Possible values are `KMS` and `None`. # @return [String] # # @!attribute [rw] data_transfer_progress_percent # The percent of data transferred from source cluster to target # cluster. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResizeProgressMessage AWS API Documentation # class ResizeProgressMessage < Struct.new( :target_node_type, :target_number_of_nodes, :target_cluster_type, :status, :import_tables_completed, :import_tables_in_progress, :import_tables_not_started, :avg_resize_rate_in_mega_bytes_per_second, :total_resize_data_in_mega_bytes, :progress_in_mega_bytes, :elapsed_time_in_seconds, :estimated_time_to_completion_in_seconds, :resize_type, :message, :target_encryption_type, :data_transfer_progress_percent) SENSITIVE = [] include Aws::Structure end # The resource could not be found. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResourceNotFoundFault AWS API Documentation # class ResourceNotFoundFault < Aws::EmptyStructure; end # @note When making an API call, you may pass RestoreFromClusterSnapshotMessage # data as a hash: # # { # cluster_identifier: "String", # required # snapshot_identifier: "String", # required # snapshot_cluster_identifier: "String", # port: 1, # availability_zone: "String", # allow_version_upgrade: false, # cluster_subnet_group_name: "String", # publicly_accessible: false, # owner_account: "String", # hsm_client_certificate_identifier: "String", # hsm_configuration_identifier: "String", # elastic_ip: "String", # cluster_parameter_group_name: "String", # cluster_security_groups: ["String"], # vpc_security_group_ids: ["String"], # preferred_maintenance_window: "String", # automated_snapshot_retention_period: 1, # manual_snapshot_retention_period: 1, # kms_key_id: "String", # node_type: "String", # enhanced_vpc_routing: false, # additional_info: "String", # iam_roles: ["String"], # maintenance_track_name: "String", # snapshot_schedule_identifier: "String", # number_of_nodes: 1, # availability_zone_relocation: false, # aqua_configuration_status: "enabled", # accepts enabled, disabled, auto # default_iam_role_arn: "String", # reserved_node_id: "String", # target_reserved_node_offering_id: "String", # encrypted: false, # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster that will be created from restoring # the snapshot. # # Constraints: # # * Must contain from 1 to 63 alphanumeric characters or hyphens. # # * Alphabetic characters must be lowercase. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # * Must be unique for all clusters within an Amazon Web Services # account. # @return [String] # # @!attribute [rw] snapshot_identifier # The name of the snapshot from which to create the new cluster. This # parameter isn't case sensitive. # # Example: `my-snapshot-id` # @return [String] # # @!attribute [rw] snapshot_cluster_identifier # The name of the cluster the source snapshot was created from. This # parameter is required if your IAM user has a policy containing a # snapshot resource element that specifies anything other than * for # the cluster name. # @return [String] # # @!attribute [rw] port # The port number on which the cluster accepts connections. # # Default: The same port as the original cluster. # # Constraints: Must be between `1115` and `65535`. # @return [Integer] # # @!attribute [rw] availability_zone # The Amazon EC2 Availability Zone in which to restore the cluster. # # Default: A random, system-chosen Availability Zone. # # Example: `us-east-2a` # @return [String] # # @!attribute [rw] allow_version_upgrade # If `true`, major version upgrades can be applied during the # maintenance window to the Amazon Redshift engine that is running on # the cluster. # # Default: `true` # @return [Boolean] # # @!attribute [rw] cluster_subnet_group_name # The name of the subnet group where you want to cluster restored. # # A snapshot of cluster in VPC can be restored only in VPC. Therefore, # you must provide subnet group name where you want the cluster # restored. # @return [String] # # @!attribute [rw] publicly_accessible # If `true`, the cluster can be accessed from a public network. # @return [Boolean] # # @!attribute [rw] owner_account # The Amazon Web Services account used to create or copy the snapshot. # Required if you are restoring a snapshot you do not own, optional if # you own the snapshot. # @return [String] # # @!attribute [rw] hsm_client_certificate_identifier # Specifies the name of the HSM client certificate the Amazon Redshift # cluster uses to retrieve the data encryption keys stored in an HSM. # @return [String] # # @!attribute [rw] hsm_configuration_identifier # 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. # @return [String] # # @!attribute [rw] elastic_ip # The elastic IP (EIP) address for the cluster. # @return [String] # # @!attribute [rw] cluster_parameter_group_name # The name of the parameter group to be associated with this cluster. # # Default: The default Amazon Redshift cluster parameter group. For # information about the default parameter group, go to [Working with # Amazon Redshift Parameter Groups][1]. # # Constraints: # # * Must be 1 to 255 alphanumeric characters or hyphens. # # * First character must be a letter. # # * Cannot end with a hyphen or contain two consecutive hyphens. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html # @return [String] # # @!attribute [rw] cluster_security_groups # A list of security groups to be associated with this cluster. # # Default: The default cluster security group for Amazon Redshift. # # Cluster security groups only apply to clusters outside of VPCs. # @return [Array] # # @!attribute [rw] vpc_security_group_ids # A list of Virtual Private Cloud (VPC) security groups to be # associated with the cluster. # # Default: The default VPC security group is associated with the # cluster. # # VPC security groups only apply to clusters in VPCs. # @return [Array] # # @!attribute [rw] preferred_maintenance_window # The weekly time range (in UTC) during which automated cluster # maintenance can occur. # # Format: `ddd:hh24:mi-ddd:hh24:mi` # # Default: The value selected for the cluster from which the snapshot # was taken. For more information about the time blocks for each # region, see [Maintenance Windows][1] in Amazon Redshift Cluster # Management Guide. # # Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun # # Constraints: Minimum 30-minute window. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows # @return [String] # # @!attribute [rw] automated_snapshot_retention_period # The number of days that automated snapshots are retained. If the # value is 0, automated snapshots are disabled. Even if automated # snapshots are disabled, you can still create manual snapshots when # you want with CreateClusterSnapshot. # # You can't disable automated snapshots for RA3 node types. Set the # automated retention period from 1-35 days. # # Default: The value selected for the cluster from which the snapshot # was taken. # # Constraints: Must be a value from 0 to 35. # @return [Integer] # # @!attribute [rw] manual_snapshot_retention_period # 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. # @return [Integer] # # @!attribute [rw] kms_key_id # The Key Management Service (KMS) key ID of the encryption key that # encrypts data in the cluster restored from a shared snapshot. You # can also provide the key ID when you restore from an unencrypted # snapshot to an encrypted cluster in the same account. Additionally, # you can specify a new KMS key ID when you restore from an encrypted # snapshot in the same account in order to change it. In that case, # the restored cluster is encrypted with the new KMS key ID. # @return [String] # # @!attribute [rw] node_type # The node type that the restored cluster will be provisioned with. # # Default: The node type of the cluster from which the snapshot was # taken. You can modify this if you are using any DS node type. In # that case, you can choose to restore into another DS node type of # the same size. For example, you can restore ds1.8xlarge into # ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC # instance type, you must restore into that same instance type and # size. In other words, you can only restore a dc1.large instance type # into another dc1.large instance type or dc2.large instance type. You # can't restore dc1.8xlarge to dc2.8xlarge. First restore to a # dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more # information about node types, see [ About Clusters and Nodes][1] in # the *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes # @return [String] # # @!attribute [rw] enhanced_vpc_routing # 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][1] in the Amazon Redshift Cluster Management # Guide. # # If this option is `true`, enhanced VPC routing is enabled. # # Default: false # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html # @return [Boolean] # # @!attribute [rw] additional_info # Reserved. # @return [String] # # @!attribute [rw] iam_roles # A list of Identity and Access Management (IAM) roles that can be # used by the cluster to access other Amazon Web Services services. # You must supply the IAM roles in their Amazon Resource Name (ARN) # format. # # The maximum number of IAM roles that you can associate is subject to # a quota. For more information, go to [Quotas and limits][1] in the # *Amazon Redshift Cluster Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html # @return [Array] # # @!attribute [rw] maintenance_track_name # The name of the maintenance track for the restored cluster. When you # take a snapshot, the snapshot inherits the `MaintenanceTrack` value # from the cluster. The snapshot might be on a different track than # the cluster that was the source for the snapshot. For example, # suppose that you take a snapshot of a cluster that is on the current # track and then change the cluster to be on the trailing track. In # this case, the snapshot and the source cluster are on different # tracks. # @return [String] # # @!attribute [rw] snapshot_schedule_identifier # A unique identifier for the snapshot schedule. # @return [String] # # @!attribute [rw] number_of_nodes # The number of nodes specified when provisioning the restored # cluster. # @return [Integer] # # @!attribute [rw] availability_zone_relocation # The option to enable relocation for an Amazon Redshift cluster # between Availability Zones after the cluster is restored. # @return [Boolean] # # @!attribute [rw] aqua_configuration_status # The value represents how the cluster is configured to use AQUA # (Advanced Query Accelerator) after the cluster is restored. Possible # values include the following. # # * enabled - Use AQUA if it is available for the current Amazon Web # Services Region and Amazon Redshift node type. # # * disabled - Don't use AQUA. # # * auto - Amazon Redshift determines whether to use AQUA. # @return [String] # # @!attribute [rw] default_iam_role_arn # The Amazon Resource Name (ARN) for the IAM role that was set as # default for the cluster when the cluster was last modified while it # was restored from a snapshot. # @return [String] # # @!attribute [rw] reserved_node_id # The identifier of the target reserved node offering. # @return [String] # # @!attribute [rw] target_reserved_node_offering_id # The identifier of the target reserved node offering. # @return [String] # # @!attribute [rw] encrypted # Enables support for restoring an unencrypted snapshot to a cluster # encrypted with Key Management Service (KMS) and a customer managed # key. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreFromClusterSnapshotMessage AWS API Documentation # class RestoreFromClusterSnapshotMessage < Struct.new( :cluster_identifier, :snapshot_identifier, :snapshot_cluster_identifier, :port, :availability_zone, :allow_version_upgrade, :cluster_subnet_group_name, :publicly_accessible, :owner_account, :hsm_client_certificate_identifier, :hsm_configuration_identifier, :elastic_ip, :cluster_parameter_group_name, :cluster_security_groups, :vpc_security_group_ids, :preferred_maintenance_window, :automated_snapshot_retention_period, :manual_snapshot_retention_period, :kms_key_id, :node_type, :enhanced_vpc_routing, :additional_info, :iam_roles, :maintenance_track_name, :snapshot_schedule_identifier, :number_of_nodes, :availability_zone_relocation, :aqua_configuration_status, :default_iam_role_arn, :reserved_node_id, :target_reserved_node_offering_id, :encrypted) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreFromClusterSnapshotResult AWS API Documentation # class RestoreFromClusterSnapshotResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Describes the status of a cluster restore action. Returns null if the # cluster was not created by restoring a snapshot. # # @!attribute [rw] status # The status of the restore action. Returns starting, restoring, # completed, or failed. # @return [String] # # @!attribute [rw] current_restore_rate_in_mega_bytes_per_second # The number of megabytes per second being transferred from the backup # storage. Returns the average rate for a completed backup. This field # is only updated when you restore to DC2 and DS2 node types. # @return [Float] # # @!attribute [rw] snapshot_size_in_mega_bytes # The size of the set of snapshot data used to restore the cluster. # This field is only updated when you restore to DC2 and DS2 node # types. # @return [Integer] # # @!attribute [rw] progress_in_mega_bytes # The number of megabytes that have been transferred from snapshot # storage. This field is only updated when you restore to DC2 and DS2 # node types. # @return [Integer] # # @!attribute [rw] elapsed_time_in_seconds # The amount of time an in-progress restore has been running, or the # amount of time it took a completed restore to finish. This field is # only updated when you restore to DC2 and DS2 node types. # @return [Integer] # # @!attribute [rw] estimated_time_to_completion_in_seconds # The estimate of the time remaining before the restore will complete. # Returns 0 for a completed restore. This field is only updated when # you restore to DC2 and DS2 node types. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreStatus AWS API Documentation # class RestoreStatus < Struct.new( :status, :current_restore_rate_in_mega_bytes_per_second, :snapshot_size_in_mega_bytes, :progress_in_mega_bytes, :elapsed_time_in_seconds, :estimated_time_to_completion_in_seconds) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RestoreTableFromClusterSnapshotMessage # data as a hash: # # { # cluster_identifier: "String", # required # snapshot_identifier: "String", # required # source_database_name: "String", # required # source_schema_name: "String", # source_table_name: "String", # required # target_database_name: "String", # target_schema_name: "String", # new_table_name: "String", # required # enable_case_sensitive_identifier: false, # } # # @!attribute [rw] cluster_identifier # The identifier of the Amazon Redshift cluster to restore the table # to. # @return [String] # # @!attribute [rw] snapshot_identifier # The identifier of the snapshot to restore the table from. This # snapshot must have been created from the Amazon Redshift cluster # specified by the `ClusterIdentifier` parameter. # @return [String] # # @!attribute [rw] source_database_name # The name of the source database that contains the table to restore # from. # @return [String] # # @!attribute [rw] source_schema_name # The name of the source schema that contains the table to restore # from. If you do not specify a `SourceSchemaName` value, the default # is `public`. # @return [String] # # @!attribute [rw] source_table_name # The name of the source table to restore from. # @return [String] # # @!attribute [rw] target_database_name # The name of the database to restore the table to. # @return [String] # # @!attribute [rw] target_schema_name # The name of the schema to restore the table to. # @return [String] # # @!attribute [rw] new_table_name # The name of the table to create as a result of the current request. # @return [String] # # @!attribute [rw] enable_case_sensitive_identifier # Indicates whether name identifiers for database, schema, and table # are case sensitive. If `true`, the names are case sensitive. If # `false` (default), the names are not case sensitive. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreTableFromClusterSnapshotMessage AWS API Documentation # class RestoreTableFromClusterSnapshotMessage < Struct.new( :cluster_identifier, :snapshot_identifier, :source_database_name, :source_schema_name, :source_table_name, :target_database_name, :target_schema_name, :new_table_name, :enable_case_sensitive_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] table_restore_status # Describes the status of a RestoreTableFromClusterSnapshot operation. # @return [Types::TableRestoreStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RestoreTableFromClusterSnapshotResult AWS API Documentation # class RestoreTableFromClusterSnapshotResult < Struct.new( :table_restore_status) SENSITIVE = [] include Aws::Structure end # Describes a resume cluster operation. For example, a scheduled action # to run the `ResumeCluster` API operation. # # @note When making an API call, you may pass ResumeClusterMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The identifier of the cluster to be resumed. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResumeClusterMessage AWS API Documentation # class ResumeClusterMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ResumeClusterResult AWS API Documentation # class ResumeClusterResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Describes a `RevisionTarget`. # # @!attribute [rw] database_revision # A unique string that identifies the version to update the cluster # to. You can use this value in ModifyClusterDbRevision. # @return [String] # # @!attribute [rw] description # A string that describes the changes and features that will be # applied to the cluster when it is updated to the corresponding # ClusterDbRevision. # @return [String] # # @!attribute [rw] database_revision_release_date # The date on which the database revision was released. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevisionTarget AWS API Documentation # class RevisionTarget < Struct.new( :database_revision, :description, :database_revision_release_date) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RevokeClusterSecurityGroupIngressMessage # data as a hash: # # { # cluster_security_group_name: "String", # required # cidrip: "String", # ec2_security_group_name: "String", # ec2_security_group_owner_id: "String", # } # # @!attribute [rw] cluster_security_group_name # The name of the security Group from which to revoke the ingress # rule. # @return [String] # # @!attribute [rw] cidrip # The IP range for which to revoke access. This range must be a valid # Classless Inter-Domain Routing (CIDR) block of IP addresses. If # `CIDRIP` is specified, `EC2SecurityGroupName` and # `EC2SecurityGroupOwnerId` cannot be provided. # @return [String] # # @!attribute [rw] ec2_security_group_name # The name of the EC2 Security Group whose access is to be revoked. If # `EC2SecurityGroupName` is specified, `EC2SecurityGroupOwnerId` must # also be provided and `CIDRIP` cannot be provided. # @return [String] # # @!attribute [rw] ec2_security_group_owner_id # The Amazon Web Services account number of the owner of the security # group specified in the `EC2SecurityGroupName` parameter. The Amazon # Web Services access key ID is not an acceptable value. If # `EC2SecurityGroupOwnerId` is specified, `EC2SecurityGroupName` must # also be provided. and `CIDRIP` cannot be provided. # # Example: `111122223333` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevokeClusterSecurityGroupIngressMessage AWS API Documentation # class RevokeClusterSecurityGroupIngressMessage < Struct.new( :cluster_security_group_name, :cidrip, :ec2_security_group_name, :ec2_security_group_owner_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster_security_group # Describes a security group. # @return [Types::ClusterSecurityGroup] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevokeClusterSecurityGroupIngressResult AWS API Documentation # class RevokeClusterSecurityGroupIngressResult < Struct.new( :cluster_security_group) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RevokeEndpointAccessMessage # data as a hash: # # { # cluster_identifier: "String", # account: "String", # vpc_ids: ["String"], # force: false, # } # # @!attribute [rw] cluster_identifier # The cluster to revoke access from. # @return [String] # # @!attribute [rw] account # The Amazon Web Services account ID whose access is to be revoked. # @return [String] # # @!attribute [rw] vpc_ids # The virtual private cloud (VPC) identifiers for which access is to # be revoked. # @return [Array] # # @!attribute [rw] force # Indicates whether to force the revoke action. If true, the # Redshift-managed VPC endpoints associated with the endpoint # authorization are also deleted. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevokeEndpointAccessMessage AWS API Documentation # class RevokeEndpointAccessMessage < Struct.new( :cluster_identifier, :account, :vpc_ids, :force) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RevokeSnapshotAccessMessage # data as a hash: # # { # snapshot_identifier: "String", # required # snapshot_cluster_identifier: "String", # account_with_restore_access: "String", # required # } # # @!attribute [rw] snapshot_identifier # The identifier of the snapshot that the account can no longer # access. # @return [String] # # @!attribute [rw] snapshot_cluster_identifier # The identifier of the cluster the snapshot was created from. This # parameter is required if your IAM user has a policy containing a # snapshot resource element that specifies anything other than * for # the cluster name. # @return [String] # # @!attribute [rw] account_with_restore_access # The identifier of the Amazon Web Services account that can no longer # restore the specified snapshot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevokeSnapshotAccessMessage AWS API Documentation # class RevokeSnapshotAccessMessage < Struct.new( :snapshot_identifier, :snapshot_cluster_identifier, :account_with_restore_access) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] snapshot # Describes a snapshot. # @return [Types::Snapshot] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RevokeSnapshotAccessResult AWS API Documentation # class RevokeSnapshotAccessResult < Struct.new( :snapshot) SENSITIVE = [] include Aws::Structure end # @note When making an API call, you may pass RotateEncryptionKeyMessage # data as a hash: # # { # cluster_identifier: "String", # required # } # # @!attribute [rw] cluster_identifier # The unique identifier of the cluster that you want to rotate the # encryption keys for. # # Constraints: Must be the name of valid cluster that has encryption # enabled. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RotateEncryptionKeyMessage AWS API Documentation # class RotateEncryptionKeyMessage < Struct.new( :cluster_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] cluster # Describes a cluster. # @return [Types::Cluster] # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/RotateEncryptionKeyResult AWS API Documentation # class RotateEncryptionKeyResult < Struct.new( :cluster) SENSITIVE = [] include Aws::Structure end # Amazon SNS has responded that there is a problem with the specified # Amazon SNS topic. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/SNSInvalidTopicFault AWS API Documentation # class SNSInvalidTopicFault < Aws::EmptyStructure; end # You do not have permission to publish to the specified Amazon SNS # topic. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/SNSNoAuthorizationFault AWS API Documentation # class SNSNoAuthorizationFault < Aws::EmptyStructure; end # An Amazon SNS topic with the specified Amazon Resource Name (ARN) does # not exist. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/SNSTopicArnNotFoundFault AWS API Documentation # class SNSTopicArnNotFoundFault < Aws::EmptyStructure; end # The definition you submitted is not supported. # # @see http://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ScheduleDefinitionTypeUnsupportedFault AWS API Documentation # class ScheduleDefinitionTypeUnsupportedFault < Aws::EmptyStructure; end # Describes a scheduled action. You can use a scheduled action to # trigger some Amazon Redshift API operations on a schedule. For # information about which API operations can be scheduled, see # ScheduledActionType. # # @!attribute [rw] scheduled_action_name # The name of the scheduled action. # @return [String] # # @!attribute [rw] target_action # A JSON format string of the Amazon Redshift API operation with input # parameters. # # "`\{"ResizeCluster":\{"NodeType":"ds2.8xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3\}\}`". # @return [Types::ScheduledActionType] # # @!attribute [rw] schedule # The schedule for a one-time (at format) or recurring (cron format) # scheduled action. Schedule invocations must be separated by at least # one hour. # # Format of at expressions is "`at(yyyy-mm-ddThh:mm:ss)`". For # example, "`at(2016-03-04T17:27:00)`". # # Format of cron expressions is "`cron(Minutes Hours Day-of-month # Month Day-of-week Year)`". For example, "`cron(0 10 ? * MON *)`". # For more information, see [Cron Expressions][1] in the *Amazon # CloudWatch Events User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions # @return [String] # # @!attribute [rw] iam_role # The IAM role to assume to run the scheduled action. This IAM role # must have permission to run the Amazon Redshift API operation in the # scheduled action. This IAM role must allow the Amazon Redshift # scheduler (Principal scheduler.redshift.amazonaws.com) to assume # permissions on your behalf. For more information about the IAM role # to use with the Amazon Redshift scheduler, see [Using Identity-Based # Policies for Amazon Redshift][1] in the *Amazon Redshift Cluster # Management Guide*. # # # # [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html # @return [String] # # @!attribute [rw] scheduled_action_description # The description of the scheduled action. # @return [String] # # @!attribute [rw] state # The state of the scheduled action. For example, `DISABLED`. # @return [String] # # @!attribute [rw] next_invocations # List of times when the scheduled action will run. # @return [Array