AWS CDK Reference

Appearance

v2.274.0

Authorization Class ​

Authorization type for an API Destination Connection.

Source
aws-events/lib/connection.ts
Type last changed
v2.13.0 · 19 Feb 2022

Example ​

ts
const connection = new events.Connection(this, 'Connection', {
  authorization: events.Authorization.apiKey('x-api-key', SecretValue.secretsManager('ApiSecretName')),
  description: 'Connection with API Key x-api-key',
});

const destination = new events.ApiDestination(this, 'Destination', {
  connection,
  endpoint: 'https://example.com',
  description: 'Calling example.com with API key x-api-key',
});

const rule = new events.Rule(this, 'Rule', {
  schedule: events.Schedule.rate(Duration.minutes(1)),
  targets: [new targets.ApiDestination(destination)],
});

Initializer ​

ts
new Authorization()
python
Authorization()
java
new Authorization()
csharp
new Authorization()
go
NewAuthorization()

Methods ​

apiKey(apiKeyName: string, apiKeyValue: SecretValue): Authorization // chainable@staticmethod def api_key(api_key_name: str, api_key_value: SecretValue) -> Authorizationpublic static Authorization apiKey(String apiKeyName, SecretValue apiKeyValue)public static Authorization ApiKey(string apiKeyName, SecretValue apiKeyValue)func ApiKey(ApiKeyName *string, ApiKeyValue SecretValue) Authorizationstatic#
Use API key authorization.

API key authorization has two components: an API key name and an API key value. What these are depends on the target of your connection.

basic(username: string, password: SecretValue): Authorization // chainable@staticmethod def basic(username: str, password: SecretValue) -> Authorizationpublic static Authorization basic(String username, SecretValue password)public static Authorization Basic(string username, SecretValue password)func Basic(Username *string, Password SecretValue) Authorizationstatic#
Use username and password authorization.
oauth(props: OAuthAuthorizationProps): Authorization // chainable@staticmethod def oauth(props: OAuthAuthorizationProps) -> Authorizationpublic static Authorization oauth(OAuthAuthorizationProps props)public static Authorization Oauth(OAuthAuthorizationProps props)func Oauth(Props OAuthAuthorizationProps) Authorizationstatic#
Use OAuth authorization.