Class Authorization

Authorization type for an API Destination Connection.

Inheritance

Authorization

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class Authorization : DeputyBase

Syntax (vb)

Public MustInherit Class Authorization Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

var connection = new Connection(this, "Connection", new ConnectionProps {
                Authorization = Authorization.ApiKey("x-api-key", SecretValue.SecretsManager("ApiSecretName")),
                Description = "Connection with API Key x-api-key"
            });

            var destination = new ApiDestination(this, "Destination", new ApiDestinationProps {
                Connection = connection,
                Endpoint = "https://example.com",
                Description = "Calling example.com with API key x-api-key"
            });

            var rule = new Rule(this, "Rule", new RuleProps {
                Schedule = Schedule.Rate(Duration.Minutes(1)),
                Targets = new [] { new ApiDestination(destination) }
            });

Synopsis

Constructors

Authorization()

Authorization type for an API Destination Connection.

Methods

ApiKey(string, SecretValue)	Use API key authorization.
Basic(string, SecretValue)	Use username and password authorization.
Oauth(IOAuthAuthorizationProps)	Use OAuth authorization.

Constructors

Authorization()

Authorization type for an API Destination Connection.

protected Authorization()

Remarks

ExampleMetadata: infused

Examples

var connection = new Connection(this, "Connection", new ConnectionProps {
                Authorization = Authorization.ApiKey("x-api-key", SecretValue.SecretsManager("ApiSecretName")),
                Description = "Connection with API Key x-api-key"
            });

            var destination = new ApiDestination(this, "Destination", new ApiDestinationProps {
                Connection = connection,
                Endpoint = "https://example.com",
                Description = "Calling example.com with API key x-api-key"
            });

            var rule = new Rule(this, "Rule", new RuleProps {
                Schedule = Schedule.Rate(Duration.Minutes(1)),
                Targets = new [] { new ApiDestination(destination) }
            });

Methods

ApiKey(string, SecretValue)

Use API key authorization.

public static Authorization ApiKey(string apiKeyName, SecretValue apiKeyValue)

Parameters

apiKeyName string
apiKeyValue SecretValue

Returns

Authorization

Remarks

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(string, SecretValue)

Use username and password authorization.

public static Authorization Basic(string username, SecretValue password)

Parameters

username string
password SecretValue

Returns

Authorization

Remarks

ExampleMetadata: infused

Oauth(IOAuthAuthorizationProps)

Use OAuth authorization.

public static Authorization Oauth(IOAuthAuthorizationProps props)

Parameters

props IOAuthAuthorizationProps

Returns

Authorization

Remarks

ExampleMetadata: infused