← Back to plugin index

AWS Custom Service Access

Description
This plugin allows to manually configure the AWS region and service endpoint to use.
Type name
AwsCustomServiceAccess
Class
com.airlock.iam.keymanagementservice.application.configuration.access.AwsCustomServiceAccessConfig
May be used by
Properties
Region (region)
Description
Specifies the AWS region to use for the service connection and endpoints. Regions enable you to access AWS services that physically reside in a specific geographic area.

If no explicit AWS region is specified, IAM will attempt to identify the region in the following order:

  1. Java system property aws.region
  2. Environment variable AWS_REGION
  3. Config files at location {user.home}/.aws/credentials and {user.home}/.aws/config
  4. Region delivered through the Amazon EC2 metadata service

IAM requires a region to connect to the AWS service, otherwise connection fails with an error.
Attributes
String
Optional
Suggested values
eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-south-1, eu-south-2, eu-west-2, eu-north-1
Endpoint URL (endpointUrl)
Description

This property defines the endpoint (URL) of the entry point for an AWS web service.

If left empty, the default endpoint for the selected region is used (refer to the official AWS documentation).

If configured, the default endpoint is overwritten with this URL.

Attributes
String
Optional
Example
https://kms.eu-west-2.amazonaws.com
Example
https://kms.us-east-1.amazonaws.com
YAML Template (with default values)

type: AwsCustomServiceAccess
id: AwsCustomServiceAccess-xxxxxx
displayName: 
comment: 
properties:
  endpointUrl:
  region: