Class: DatadogAPIClient::V2::ObservabilityPipelineAmazonOpenSearchDestinationAuth
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::ObservabilityPipelineAmazonOpenSearchDestinationAuth
- Includes:
- BaseGenericModel
- Defined in:
- lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb
Overview
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.
Instance Attribute Summary collapse
-
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
-
#assume_role ⇒ Object
The ARN of the role to assume (used with
awsstrategy). -
#aws_region ⇒ Object
AWS region.
-
#external_id ⇒ Object
External ID for the assumed role (used with
awsstrategy). -
#password_key ⇒ Object
Name of the environment variable or secret that holds the Amazon OpenSearch password (used when
strategyisbasic). -
#session_name ⇒ Object
Session name for the assumed role (used with
awsstrategy). -
#strategy ⇒ Object
readonly
The authentication strategy to use.
-
#username_key ⇒ Object
Name of the environment variable or secret that holds the Amazon OpenSearch username (used when
strategyisbasic).
Method Summary
Methods included from BaseGenericModel
Instance Attribute Details
#additional_properties ⇒ Object
Returns the value of attribute additional_properties.
47 48 49 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 47 def additional_properties @additional_properties end |
#assume_role ⇒ Object
The ARN of the role to assume (used with aws strategy).
27 28 29 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 27 def assume_role @assume_role end |
#aws_region ⇒ Object
AWS region
30 31 32 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 30 def aws_region @aws_region end |
#external_id ⇒ Object
External ID for the assumed role (used with aws strategy).
33 34 35 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 33 def external_id @external_id end |
#password_key ⇒ Object
Name of the environment variable or secret that holds the Amazon OpenSearch password (used when strategy is basic).
36 37 38 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 36 def password_key @password_key end |
#session_name ⇒ Object
Session name for the assumed role (used with aws strategy).
39 40 41 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 39 def session_name @session_name end |
#strategy ⇒ Object
The authentication strategy to use.
42 43 44 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 42 def strategy @strategy end |
#username_key ⇒ Object
Name of the environment variable or secret that holds the Amazon OpenSearch username (used when strategy is basic).
45 46 47 |
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination_auth.rb', line 45 def username_key @username_key end |