aws-api API
Namespaces
Clojure Home

API for cognitect.aws.region - aws-api


Full namespace name: cognitect.aws.region

Overview

Region providers. Primarily for internal use, and subject to change.

Public Variables and Functions


chain-region-provider

function
Usage: (chain-region-provider providers)

Chain together multiple region providers.

`fetch` calls each provider in order until one returns a non-nil result,
or returns nil.

Alpha. Subject to change.

default-region-provider

function
Usage: (default-region-provider http-client)

Returns a chain-region-provider with, in order:

  environment-region-provider
  system-property-region-provider
  profile-region-provider
  instance-region-IMDS-v2-provider
  instance-region-provider

Alpha. Subject to change.

environment-region-provider

function
Usage: (environment-region-provider)

Returns the region from the AWS_REGION env var, or nil if not present.

Alpha. Subject to change.

fetch

function
Usage: (fetch _)

Returns the region found by this provider, or nil.

fetch-async

function
Usage: (fetch-async provider)

Returns a channel that will produce the result of calling fetch on
the provider.

Alpha. Subject to change.

instance-region-IMDS-v2-provider

function
Usage: (instance-region-IMDS-v2-provider http-client)

Returns the region from the ec2 instance's IMDS v2 metadata service,
or nil if the service can not be found.

Alpha. Subject to change.

instance-region-provider

function
Usage: (instance-region-provider http-client)

Returns the region from the ec2 instance's metadata service,
or nil if the service can not be found.

DEPRECATED use `instance-region-IMDS-v2-provider`

Alpha. Subject to change.
Deprecated since aws-api version true

profile-region-provider

function
Usage: (profile-region-provider)
       (profile-region-provider profile-name)
       (profile-region-provider profile-name f)

Returns the region from an AWS configuration profile.

Arguments:

  f             File    The profile configuration file. (default: ~/.aws/config)
  profile-name  string  The name of the profile in the file. (default: default)

Parsed properties:

  region        required

Alpha. Subject to change.

system-property-region-provider

function
Usage: (system-property-region-provider)

Returns the region from the aws.region system property, or nil if not present.

Alpha. Subject to change.
Logo & site design by Tom Hickey.
Clojure auto-documentation system by Tom Faulhaber.