modify_cluster ¶

def modify_cluster(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    cluster_type: Optional["capo_redshift.types.string.String"] = None,
    node_type: Optional["capo_redshift.types.string.String"] = None,
    number_of_nodes: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    cluster_security_groups: Optional[
        "capo_redshift.types.cluster_security_group_name_list.ClusterSecurityGroupNameList"
    ] = None,
    vpc_security_group_ids: Optional[
        "capo_redshift.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ] = None,
    master_user_password: Optional[
        "capo_redshift.types.sensitive_string.SensitiveString"
    ] = None,
    cluster_parameter_group_name: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    automated_snapshot_retention_period: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    manual_snapshot_retention_period: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    preferred_maintenance_window: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    cluster_version: Optional["capo_redshift.types.string.String"] = None,
    allow_version_upgrade: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    hsm_client_certificate_identifier: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    hsm_configuration_identifier: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    new_cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    publicly_accessible: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    elastic_ip: Optional["capo_redshift.types.string.String"] = None,
    enhanced_vpc_routing: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    maintenance_track_name: Optional["capo_redshift.types.string.String"] = None,
    encrypted: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    kms_key_id: Optional["capo_redshift.types.string.String"] = None,
    availability_zone_relocation: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    availability_zone: Optional["capo_redshift.types.string.String"] = None,
    port: Optional["capo_redshift.types.integer_optional.IntegerOptional"] = None,
    manage_master_password: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    master_password_secret_kms_key_id: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    ip_address_type: Optional["capo_redshift.types.string.String"] = None,
    multi_az: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
    extra_compute_for_automatic_optimization: Optional[
        "capo_redshift.types.boolean_optional.BooleanOptional"
    ] = None,
) -> "capo_redshift.types.modify_cluster_result.ModifyClusterResult":
    r"""<p>Modifies the settings for a cluster.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p> <p>You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:</p> <ul> <li> <p>Creating a public cluster</p> </li> <li> <p>Restoring a public cluster</p> </li> <li> <p>Modifying a private cluster to be public</p> </li> <li> <p>Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group</p> </li> </ul> <p>For more information about VPC BPA, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html">Block public access to VPCs and subnets</a> in the <i>Amazon VPC User Guide</i>.</p>

    Args:
        cluster_identifier: <p>The unique identifier of the cluster to be modified.</p> <p>Example: <code>examplecluster</code> </p>
        cluster_type: <p>The new cluster type.</p> <p>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 <a>DescribeResize</a> to track the progress of the resize request. </p> <p>Valid Values: <code> multi-node | single-node </code> </p>
        node_type: <p>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.</p> <p> For more information about resizing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: <code>dc2.large</code> | <code>dc2.8xlarge</code> | <code>rg.large</code> | <code>rg.xlarge</code> | <code>rg.4xlarge</code> | <code>rg.12xlarge</code> | <code>ra3.large</code> | <code>ra3.xlplus</code> | <code>ra3.4xlarge</code> | <code>ra3.16xlarge</code> </p>
        number_of_nodes: <p>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.</p> <p> For more information about resizing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: Integer greater than <code>0</code>.</p>
        cluster_security_groups: <p>A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.</p> <p>Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters or hyphens</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
        vpc_security_group_ids: <p>A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.</p>
        master_user_password: <p>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 <code>MasterUserPassword</code> element exists in the <code>PendingModifiedValues</code> element of the operation response. </p> <p>You can't use <code>MasterUserPassword</code> if <code>ManageMasterPassword</code> is <code>true</code>.</p> <note> <p>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.</p> </note> <p>Default: Uses existing setting.</p> <p>Constraints:</p> <ul> <li> <p>Must be between 8 and 64 characters in length.</p> </li> <li> <p>Must contain at least one uppercase letter.</p> </li> <li> <p>Must contain at least one lowercase letter.</p> </li> <li> <p>Must contain one number.</p> </li> <li> <p>Can be any printable ASCII character (ASCII code 33-126) except <code>'</code> (single quote), <code>"</code> (double quote), <code>\</code>, <code>/</code>, or <code>@</code>.</p> </li> </ul>
        cluster_parameter_group_name: <p>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 <a>RebootCluster</a>. </p> <p>Default: Uses existing setting.</p> <p>Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.</p>
        automated_snapshot_retention_period: <p>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 <a>CreateClusterSnapshot</a>. </p> <p>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.</p> <p>You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days.</p> <p>Default: Uses existing setting.</p> <p>Constraints: Must be a value from 0 to 35.</p>
        manual_snapshot_retention_period: <p>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.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p> <p>The default value is -1.</p>
        preferred_maintenance_window: <p>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.</p> <p>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.</p> <p>Default: Uses existing setting.</p> <p>Format: ddd:hh24:mi-ddd:hh24:mi, for example <code>wed:07:30-wed:08:00</code>.</p> <p>Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun</p> <p>Constraints: Must be at least 30 minutes.</p>
        cluster_version: <p>The new version number of the Amazon Redshift engine to upgrade to.</p> <p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Example: <code>1.0</code> </p>
        allow_version_upgrade: <p>If <code>true</code>, major version upgrades will be applied automatically to the cluster during the maintenance window. </p> <p>Default: <code>false</code> </p>
        hsm_client_certificate_identifier: <p>Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.</p>
        hsm_configuration_identifier: <p>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.</p>
        new_cluster_identifier: <p>The new identifier for the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>Alphabetic characters must be lowercase.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> <li> <p>Must be unique for all clusters within an Amazon Web Services account.</p> </li> </ul> <p>Example: <code>examplecluster</code> </p>
        publicly_accessible: <p>If <code>true</code>, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.</p> <p>Default: false</p>
        elastic_ip: <p>The Elastic IP (EIP) address for the cluster.</p> <p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms">Supported Platforms to Launch Your Cluster</a> in the Amazon Redshift Cluster Management Guide.</p>
        enhanced_vpc_routing: <p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>
        maintenance_track_name: <p>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 <code>PendingModifiedValues</code> 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.</p>
        encrypted: <p>Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the <code>KmsKeyId</code> parameter, we encrypt the cluster with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>, we encrypt with the default key. </p> <p>If the value is not encrypted (false), then the cluster is decrypted. </p>
        kms_key_id: <p>The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.</p>
        availability_zone_relocation: <p>The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.</p>
        availability_zone: <p>The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.</p>
        port: <p>The option to change the port of an Amazon Redshift cluster.</p> <p>Valid Values: </p> <ul> <li> <p>For clusters with RG or RA3 nodes - Select a port within the ranges <code>5431-5455</code> or <code>8191-8215</code>. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.)</p> </li> <li> <p>For clusters with dc2 nodes - Select a port within the range <code>1150-65535</code>.</p> </li> </ul>
        manage_master_password: <p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use <code>MasterUserPassword</code> if <code>ManageMasterPassword</code> is true. If <code>ManageMasterPassword</code> is false or not set, Amazon Redshift uses <code>MasterUserPassword</code> for the admin user account's password. </p>
        master_password_secret_kms_key_id: <p>The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if <code>ManageMasterPassword</code> is true.</p>
        ip_address_type: <p>The IP address types that the cluster supports. Possible values are <code>ipv4</code> and <code>dualstack</code>.</p>
        multi_az: <p>If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.</p>
        extra_compute_for_automatic_optimization: <p>If <code>true</code>, allocates additional compute resources for running automatic optimization operations.</p> <p>Default: false</p>

    Raises:
        capo_redshift.errors.cluster_already_exists_fault.ClusterAlreadyExistsFault: <p>The account already has a cluster with the given identifier.</p>
        capo_redshift.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.cluster_parameter_group_not_found_fault.ClusterParameterGroupNotFoundFault: <p>The parameter group name does not refer to an existing parameter group.</p>
        capo_redshift.errors.cluster_security_group_not_found_fault.ClusterSecurityGroupNotFoundFault: <p>The cluster security group name does not refer to an existing cluster security group.</p>
        capo_redshift.errors.custom_cname_association_fault.CustomCnameAssociationFault: <p>An error occurred when an attempt was made to change the custom domain association.</p>
        capo_redshift.errors.dependent_service_request_throttling_fault.DependentServiceRequestThrottlingFault: <p>The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.</p>
        capo_redshift.errors.hsm_client_certificate_not_found_fault.HsmClientCertificateNotFoundFault: <p>There is no Amazon Redshift HSM client certificate with the specified identifier.</p>
        capo_redshift.errors.hsm_configuration_not_found_fault.HsmConfigurationNotFoundFault: <p>There is no Amazon Redshift HSM configuration with the specified identifier.</p>
        capo_redshift.errors.insufficient_cluster_capacity_fault.InsufficientClusterCapacityFault: <p>The number of nodes specified exceeds the allotted capacity of the cluster.</p>
        capo_redshift.errors.invalid_cluster_security_group_state_fault.InvalidClusterSecurityGroupStateFault: <p>The state of the cluster security group is not <code>available</code>. </p>
        capo_redshift.errors.invalid_cluster_state_fault.InvalidClusterStateFault: <p>The specified cluster is not in the <code>available</code> state. </p>
        capo_redshift.errors.invalid_cluster_track_fault.InvalidClusterTrackFault: <p>The provided cluster track name is not valid.</p>
        capo_redshift.errors.invalid_elastic_ip_fault.InvalidElasticIpFault: <p>The Elastic IP (EIP) is invalid or cannot be found.</p>
        capo_redshift.errors.invalid_retention_period_fault.InvalidRetentionPeriodFault: <p>The retention period specified is either in the past or is not a valid value.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>
        capo_redshift.errors.ipv6_cidr_block_not_found_fault.Ipv6CidrBlockNotFoundFault: <p>There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.</p>
        capo_redshift.errors.limit_exceeded_fault.LimitExceededFault: <p>The encryption key has exceeded its grant limit in Amazon Web Services KMS.</p>
        capo_redshift.errors.number_of_nodes_per_cluster_limit_exceeded_fault.NumberOfNodesPerClusterLimitExceededFault: <p>The operation would exceed the number of nodes allowed for a cluster.</p>
        capo_redshift.errors.number_of_nodes_quota_exceeded_fault.NumberOfNodesQuotaExceededFault: <p>The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-limits.html">Limits in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>
        capo_redshift.errors.table_limit_exceeded_fault.TableLimitExceededFault: <p>The number of tables in the cluster exceeds the limit for the requested new cluster node type. </p>
        capo_redshift.errors.unauthorized_operation.UnauthorizedOperation: <p>Your account is not authorized to perform the requested operation.</p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.unsupported_option_fault.UnsupportedOptionFault: <p>A request option was specified that is not supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.modify_cluster_message.ModifyClusterMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.modify_cluster_result.ModifyClusterResult"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.modify_cluster

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.modify_cluster.modify_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_redshift.types.modify_cluster_message.ModifyClusterMessage",
    ) -> dict[str, Any]:
        import capo_redshift.types.modify_cluster_message

        return capo_redshift.types.modify_cluster_message.redact_sensitive(input_)

    def _redact_output(
        output: "capo_redshift.types.modify_cluster_result.ModifyClusterResult",
    ) -> dict[str, Any]:
        import capo_redshift.types.modify_cluster_result

        return capo_redshift.types.modify_cluster_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ModifyCluster",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_redshift.types.modify_cluster_message.ModifyClusterMessage = {}
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier
    if cluster_type is not None:
        input_["cluster_type"] = cluster_type
    if node_type is not None:
        input_["node_type"] = node_type
    if number_of_nodes is not None:
        input_["number_of_nodes"] = number_of_nodes
    if cluster_security_groups is not None:
        input_["cluster_security_groups"] = cluster_security_groups
    if vpc_security_group_ids is not None:
        input_["vpc_security_group_ids"] = vpc_security_group_ids
    if master_user_password is not None:
        input_["master_user_password"] = master_user_password
    if cluster_parameter_group_name is not None:
        input_["cluster_parameter_group_name"] = cluster_parameter_group_name
    if automated_snapshot_retention_period is not None:
        input_["automated_snapshot_retention_period"] = (
            automated_snapshot_retention_period
        )
    if manual_snapshot_retention_period is not None:
        input_["manual_snapshot_retention_period"] = (
            manual_snapshot_retention_period
        )
    if preferred_maintenance_window is not None:
        input_["preferred_maintenance_window"] = preferred_maintenance_window
    if cluster_version is not None:
        input_["cluster_version"] = cluster_version
    if allow_version_upgrade is not None:
        input_["allow_version_upgrade"] = allow_version_upgrade
    if hsm_client_certificate_identifier is not None:
        input_["hsm_client_certificate_identifier"] = (
            hsm_client_certificate_identifier
        )
    if hsm_configuration_identifier is not None:
        input_["hsm_configuration_identifier"] = hsm_configuration_identifier
    if new_cluster_identifier is not None:
        input_["new_cluster_identifier"] = new_cluster_identifier
    if publicly_accessible is not None:
        input_["publicly_accessible"] = publicly_accessible
    if elastic_ip is not None:
        input_["elastic_ip"] = elastic_ip
    if enhanced_vpc_routing is not None:
        input_["enhanced_vpc_routing"] = enhanced_vpc_routing
    if maintenance_track_name is not None:
        input_["maintenance_track_name"] = maintenance_track_name
    if encrypted is not None:
        input_["encrypted"] = encrypted
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if availability_zone_relocation is not None:
        input_["availability_zone_relocation"] = availability_zone_relocation
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if port is not None:
        input_["port"] = port
    if manage_master_password is not None:
        input_["manage_master_password"] = manage_master_password
    if master_password_secret_kms_key_id is not None:
        input_["master_password_secret_kms_key_id"] = (
            master_password_secret_kms_key_id
        )
    if ip_address_type is not None:
        input_["ip_address_type"] = ip_address_type
    if multi_az is not None:
        input_["multi_az"] = multi_az
    if extra_compute_for_automatic_optimization is not None:
        input_["extra_compute_for_automatic_optimization"] = (
            extra_compute_for_automatic_optimization
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output