Skip to content

delete_cache_subnet_group

delete_cache_subnet_group(
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_subnet_group_name: Optional[String] = None,
) -> None

Deletes a cache subnet group.

You cannot delete a default cache subnet group or one that is associated with any clusters.

Parameters:

  • cache_subnet_group_name (Optional[String], default: None ) –

    The name of the cache subnet group to delete.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Raises:

Examples:

DeleteCacheSubnetGroup Deletes the Amazon ElastiCache subnet group my-subnet-group.

>>> client.delete_cache_subnet_group(cache_subnet_group_name='my-subnet-group')
Source code in docs_src/capo_elasticache/_services/elasti_cache.py
def delete_cache_subnet_group(
    self,
    *,
    config_overrides: Optional[ElastiCacheClientConfig] = None,
    cache_subnet_group_name: Optional[
        "capo_elasticache.types.string.String"
    ] = None,
) -> None:
    """<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p> </note>

    Args:
        cache_subnet_group_name: <p>The name of the cache subnet group to delete.</p> <p>Constraints: Must contain no more than 255 alphanumeric characters or hyphens.</p>

    Raises:
        capo_elasticache.errors.cache_subnet_group_in_use.CacheSubnetGroupInUse: <p>The requested cache subnet group is currently in use.</p>
        capo_elasticache.errors.cache_subnet_group_not_found_fault.CacheSubnetGroupNotFoundFault: <p>The requested cache subnet group name does not refer to an existing cache subnet group.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DeleteCacheSubnetGroup
        Deletes the Amazon ElastiCache subnet group my-subnet-group.

        >>> client.delete_cache_subnet_group(cache_subnet_group_name='my-subnet-group')
    """

    def _handler(
        req: "OperationRequest[capo_elasticache.types.delete_cache_subnet_group_message.DeleteCacheSubnetGroupMessage]",
    ) -> OperationResponse[None]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.delete_cache_subnet_group

        output, http_response = (
            capo_elasticache._operations.amazon_elasti_cache_v9.delete_cache_subnet_group.delete_cache_subnet_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCacheSubnetGroup")
    )
    input_: capo_elasticache.types.delete_cache_subnet_group_message.DeleteCacheSubnetGroupMessage = {}
    if cache_subnet_group_name is not None:
        input_["cache_subnet_group_name"] = cache_subnet_group_name

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