@aws-sdk/middleware-bucket-endpoint/dist-types/bucketHostnameUtils.d.ts

[](https://www.npmjs.com/package/@aws-sdk/middleware-bucket-endpoint) [](http

import { ARN } from "@aws-sdk/util-arn-parser";
/**
 * @deprecated unused as of EndpointsV2.
 */
export declare const DOT_PATTERN: RegExp;
/**
 * @deprecated unused as of EndpointsV2.
 */
export declare const S3_HOSTNAME_PATTERN: RegExp;
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export interface AccessPointArn extends ARN {
    accessPointName: string;
}
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export interface BucketHostnameParams {
    isCustomEndpoint?: boolean;
    baseHostname: string;
    bucketName: string;
    clientRegion: string;
    accelerateEndpoint?: boolean;
    dualstackEndpoint?: boolean;
    fipsEndpoint?: boolean;
    pathStyleEndpoint?: boolean;
    tlsCompatible?: boolean;
}
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export interface ArnHostnameParams extends Omit<BucketHostnameParams, "bucketName"> {
    bucketName: ARN;
    clientSigningRegion?: string;
    clientPartition?: string;
    useArnRegion?: boolean;
    disableMultiregionAccessPoints?: boolean;
}
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export declare const isBucketNameOptions: (options: BucketHostnameParams | ArnHostnameParams) => options is BucketHostnameParams;
/**
 * Determines whether a given string is DNS compliant per the rules outlined by
 * S3. Length, capitaization, and leading dot restrictions are enforced by the
 * DOMAIN_PATTERN regular expression.
 * @internal
 *
 * @see https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html
 *
 * @deprecated unused as of EndpointsV2.
 */
export declare const isDnsCompatibleBucketName: (bucketName: string) => boolean;
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export declare const getSuffix: (hostname: string) => [string, string];
/**
 * Infer region and hostname suffix from a complete hostname
 * @internal
 * @param hostname - Hostname
 * @returns [Region, Hostname suffix]
 *
 * @deprecated unused as of EndpointsV2.
 */
export declare const getSuffixForArnEndpoint: (hostname: string) => [string, string];
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export declare const validateArnEndpointOptions: (options: {
    accelerateEndpoint?: boolean;
    tlsCompatible?: boolean;
    pathStyleEndpoint?: boolean;
}) => void;
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export declare const validateService: (service: string) => void;
/**
 * @deprecated unused as of EndpointsV2.
 * @internal
 */
export declare const validateS3Service: (service: string) => void;
/**
 * @internal
 */
export declare const validateOutpostService: (service: string) => void;
/**
 * Validate partition inferred from ARN is the same to `options.clientPartition`.
 * @internal
 */
export declare const validatePartition: (partition: string, options: {
    clientPartition: string;
}) => void;
/**
 * (Previous to deprecation)
 * validate region value inferred from ARN. If `options.useArnRegion` is set, it validates the region is not a FIPS
 * region. If `options.useArnRegion` is unset, it validates the region is equal to `options.clientRegion` or
 * `options.clientSigningRegion`.
 *
 * @internal
 *
 * @deprecated validation is deferred to the endpoint ruleset.
 */
export declare const validateRegion: (region: string, options: {
    useArnRegion?: boolean;
    allowFipsRegion?: boolean;
    clientRegion: string;
    clientSigningRegion: string;
    useFipsEndpoint: boolean;
}) => void;
/**
 * @deprecated unused as of EndpointsV2.
 */
export declare const validateRegionalClient: (region: string) => void;
/**
 * Validate an account ID
 * @internal
 */
export declare const validateAccountId: (accountId: string) => void;
/**
 * Validate a host label according to https://tools.ietf.org/html/rfc3986#section-3.2.2
 * @internal
 * @deprecated unused as of EndpointsV2.
 */
export declare const validateDNSHostLabel: (label: string, options?: {
    tlsCompatible?: boolean;
}) => void;
/**
 * @deprecated unused as of EndpointsV2.
 */
export declare const validateCustomEndpoint: (options: {
    isCustomEndpoint?: boolean;
    dualstackEndpoint?: boolean;
    accelerateEndpoint?: boolean;
}) => void;
/**
 * Validate and parse an Access Point ARN or Outposts ARN
 * @internal
 *
 * @param resource - The resource section of an ARN
 * @returns Access Point Name and optional Outpost ID.
 */
export declare const getArnResources: (resource: string) => {
    accesspointName: string;
    outpostId?: string;
};
/**
 * (Prior to deprecation) Throw if dual stack configuration is set to true.
 * @internal
 *
 * @deprecated validation deferred to endpoints ruleset.
 */
export declare const validateNoDualstack: (dualstackEndpoint?: boolean) => void;
/**
 * Validate fips endpoint is not set up.
 * @internal
 * @deprecated unused as of EndpointsV2.
 */
export declare const validateNoFIPS: (useFipsEndpoint?: boolean) => void;
/**
 * Validate the multi-region access point alias.
 * @internal
 * @deprecated unused as of EndpointsV2.
 */
export declare const validateMrapAlias: (name: string) => void;