Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/middleware-sdk-s3-control

Index

References

NODE_USE_ARN_REGION_CONFIG_OPTIONS

Re-exports NODE_USE_ARN_REGION_CONFIG_OPTIONS

NODE_USE_ARN_REGION_CONFIG_OPTIONS

Re-exports NODE_USE_ARN_REGION_CONFIG_OPTIONS

RedirectFromPostIdMiddlewareConfig

Re-exports RedirectFromPostIdMiddlewareConfig

S3ControlInputConfig

Re-exports S3ControlInputConfig

S3ControlResolvedConfig

Re-exports S3ControlResolvedConfig

getOutpostEndpoint

Re-exports getOutpostEndpoint

getProcessArnablesPlugin

Re-exports getProcessArnablesPlugin

getProcessArnablesPlugin

Re-exports getProcessArnablesPlugin

getRedirectFromPostIdPlugin

Re-exports getRedirectFromPostIdPlugin

parseOutpostArnablesMiddleaware

Re-exports parseOutpostArnablesMiddleaware

parseOutpostArnablesMiddleaware

Re-exports parseOutpostArnablesMiddleaware

parseOutpostArnablesMiddleawareOptions

Re-exports parseOutpostArnablesMiddleawareOptions

parseOutpostArnablesMiddleawareOptions

Re-exports parseOutpostArnablesMiddleawareOptions

redirectFromPostIdMiddleware

Re-exports redirectFromPostIdMiddleware

redirectFromPostIdMiddlewareOptions

Re-exports redirectFromPostIdMiddlewareOptions

resolveS3ControlConfig

Re-exports resolveS3ControlConfig

updateArnablesRequestMiddleware

Re-exports updateArnablesRequestMiddleware

updateArnablesRequestMiddleware

Re-exports updateArnablesRequestMiddleware

updateArnablesRequestMiddlewareOptions

Re-exports updateArnablesRequestMiddlewareOptions

updateArnablesRequestMiddlewareOptions

Re-exports updateArnablesRequestMiddlewareOptions

Type aliases

ArnableInput

ArnableInput: { AccountId?: string; Bucket?: string; Name?: string }

Type declaration

  • Optional AccountId?: string
  • Optional Bucket?: string
  • Optional Name?: string

InputType

InputType: { OutpostId?: string }

Type declaration

  • Optional OutpostId?: string

ValidateOutpostsArnOptions

ValidateOutpostsArnOptions: { clientPartition: string; clientRegion: string; signingRegion: string; useArnRegion: boolean; useDualstackEndpoint: boolean; useFipsEndpoint: boolean }

Type declaration

  • clientPartition: string
  • clientRegion: string
  • signingRegion: string
  • useArnRegion: boolean
  • useDualstackEndpoint: boolean
  • useFipsEndpoint: boolean

Variables

Const ACCOUNT_ID_HEADER

ACCOUNT_ID_HEADER: "x-amz-account-id" = "x-amz-account-id"

Const CONTEXT_ACCOUNT_ID

CONTEXT_ACCOUNT_ID: "account_id" = "account_id"

Const CONTEXT_ARN_REGION

CONTEXT_ARN_REGION: "outpost_arn_region" = "outpost_arn_region"

Const CONTEXT_OUTPOST_ID

CONTEXT_OUTPOST_ID: "outpost_id" = "outpost_id"

Const CONTEXT_SIGNING_REGION

CONTEXT_SIGNING_REGION: "signing_region" = "signing_region"

Const CONTEXT_SIGNING_SERVICE

CONTEXT_SIGNING_SERVICE: "signing_service" = "signing_service"

Const OUTPOST_ID_HEADER

OUTPOST_ID_HEADER: "x-amz-outpost-id" = "x-amz-outpost-id"

Const REGEX_S3CONTROL_HOSTNAME

REGEX_S3CONTROL_HOSTNAME: RegExp = /^(.+\.)?s3-control(-fips)?[.-]([a-z0-9-]+)\./

Functions

Const getOutpostEndpoint

  • getOutpostEndpoint(hostname: string, __namedParameters: { isCustomEndpoint: boolean; regionOverride: string; useFipsEndpoint: boolean }): string

Const getProcessArnablesPlugin

Const getRedirectFromPostIdPlugin

Const parseOutpostArnablesMiddleaware

Const parseOutpostBucketArnResource

  • parseOutpostBucketArnResource(resource: string): { bucketName: string; outpostId: string }

Const parseOutpostsAccessPointArnResource

  • parseOutpostsAccessPointArnResource(resource: string): { accesspointName: string; outpostId: string }

Const redirectFromPostIdMiddleware

resolveS3ControlConfig

Const updateArnablesRequestMiddleware

Const validateOutpostsArn

  • validateOutpostsArn(arn: ARN, __namedParameters: { clientPartition: string; clientRegion: string; signingRegion: string; useArnRegion: boolean; useDualstackEndpoint: boolean; useFipsEndpoint: boolean }): void
  • validate ARN with 's3-outposts' in the service section of the ARN: ARN supplied to 'Name' parameter should comply template: arn:{partition}:s3-outposts:{region}:{accountId}:outpost/{outpostId}/accesspoint/{accesspointName} ARN supplied to 'Bucket' parameter should comply template: arn:{partition}:s3-outposts:{region}:{accountId}:outpost/{outpostId}/bucket/{bucketName}

    Parameters

    • arn: ARN
    • __namedParameters: { clientPartition: string; clientRegion: string; signingRegion: string; useArnRegion: boolean; useDualstackEndpoint: boolean; useFipsEndpoint: boolean }
      • clientPartition: string
      • clientRegion: string
      • signingRegion: string
      • useArnRegion: boolean
      • useDualstackEndpoint: boolean
      • useFipsEndpoint: boolean

    Returns void

Object literals

Const parseOutpostArnablesMiddleawareOptions

parseOutpostArnablesMiddleawareOptions: object

name

name: string = "parseOutpostArnablesMiddleaware"

step

step: "initialize" = "initialize"

tags

tags: string[] = ["CONVERT_ARN", "OUTPOST_BUCKET_ARN", "OUTPOST_ACCESS_POINT_ARN", "OUTPOST"]

Const redirectFromPostIdMiddlewareOptions

redirectFromPostIdMiddlewareOptions: object

name

name: string = "redirectFromPostIdMiddleware"

override

override: true = true

step

step: "build" = "build"

tags

tags: string[] = ["OUTPOST"]

Const updateArnablesRequestMiddlewareOptions

updateArnablesRequestMiddlewareOptions: object

name

name: string = "updateArnablesRequestMiddleware"

step

step: "build" = "build"

tags

tags: string[] = ["ACCOUNT_ID", "OUTPOST_ID", "OUTPOST"]