Class ObservabilityPipelineAmazonOpenSearchDestinationAuth

Authentication settings for the Amazon OpenSearch destination. The strategy field determines whether basic or AWS-based authentication is used. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

Hierarchy

  • ObservabilityPipelineAmazonOpenSearchDestinationAuth

Constructors

constructor

Properties

additionalProperties? assumeRole? awsRegion? externalId? passwordKey? sessionName? strategy usernameKey?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional assumeRole

assumeRole?: string

The ARN of the role to assume (used with aws strategy).

Optional awsRegion

awsRegion?: string

AWS region

Optional externalId

externalId?: string

External ID for the assumed role (used with aws strategy).

Optional passwordKey

passwordKey?: string

Name of the environment variable or secret that holds the Amazon OpenSearch password (used when strategy is basic).

Optional sessionName

sessionName?: string

Session name for the assumed role (used with aws strategy).

strategy

strategy: ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy

The authentication strategy to use.

Optional usernameKey

usernameKey?: string

Name of the environment variable or secret that holds the Amazon OpenSearch username (used when strategy is basic).

Settings

Member Visibility

Theme

Generated using TypeDoc