Redshift / Client / modify_cluster_subnet_group

modify_cluster_subnet_group#

Redshift.Client.modify_cluster_subnet_group(**kwargs)#

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

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:

  • Creating a public cluster

  • Restoring a public cluster

  • Modifying a private cluster to be public

  • Adding a subnet with VPC BPA turned on to the subnet group when there’s at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

See also: AWS API Documentation

Request Syntax

response = client.modify_cluster_subnet_group(
    ClusterSubnetGroupName='string',
    Description='string',
    SubnetIds=[
        'string',
    ]
)
Parameters:

  • ClusterSubnetGroupName (string) –

    [REQUIRED]

    The name of the subnet group to be modified.

  • Description (string) – A text description of the subnet group to be modified.

  • SubnetIds (list) –

    [REQUIRED]

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ClusterSubnetGroup': {
        'ClusterSubnetGroupName': 'string',
        'Description': 'string',
        'VpcId': 'string',
        'SubnetGroupStatus': 'string',
        'Subnets': [
            {
                'SubnetIdentifier': 'string',
                'SubnetAvailabilityZone': {
                    'Name': 'string',
                    'SupportedPlatforms': [
                        {
                            'Name': 'string'
                        },
                    ]
                },
                'SubnetStatus': 'string'
            },
        ],
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'SupportedClusterIpAddressTypes': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • ClusterSubnetGroup (dict) –

      Describes a subnet group.

      • ClusterSubnetGroupName (string) –

        The name of the cluster subnet group.

      • Description (string) –

        The description of the cluster subnet group.

      • VpcId (string) –

        The VPC ID of the cluster subnet group.

      • SubnetGroupStatus (string) –

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

      • Subnets (list) –

        A list of the VPC Subnet elements.

        • (dict) –

          Describes a subnet.

          • SubnetIdentifier (string) –

            The identifier of the subnet.

          • SubnetAvailabilityZone (dict) –

            • Name (string) –

              The name of the availability zone.

            • SupportedPlatforms (list) –

              • (dict) –

                A list of supported platforms for orderable clusters.

                • Name (string) –

          • SubnetStatus (string) –

            The status of the subnet.

      • Tags (list) –

        The list of tags for the cluster subnet group.

        • (dict) –

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

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

      • SupportedClusterIpAddressTypes (list) –

        The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack.

        • (string) –

Exceptions

  • Redshift.Client.exceptions.ClusterSubnetGroupNotFoundFault

  • Redshift.Client.exceptions.ClusterSubnetQuotaExceededFault

  • Redshift.Client.exceptions.SubnetAlreadyInUse

  • Redshift.Client.exceptions.InvalidSubnet

  • Redshift.Client.exceptions.UnauthorizedOperation

  • Redshift.Client.exceptions.DependentServiceRequestThrottlingFault