aws-cdk-lib.aws_devopsagent.CfnService.ApiKeyDetailsProperty

ApiKeyDetailsProperty Struct

API key authentication details.

Source

Generated code

Type last changed

v2.241.0 · 2 Mar 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_devopsagent as devopsagent } from 'aws-cdk-lib';
const apiKeyDetailsProperty: devopsagent.CfnService.ApiKeyDetailsProperty = {
  apiKeyHeader: 'apiKeyHeader',
  apiKeyName: 'apiKeyName',
  apiKeyValue: 'apiKeyValue',
};

Properties

apiKeyHeaderstringapi_key_headerstrapiKeyHeaderStringApiKeyHeaderstringApiKeyHeader*stringrequired#

HTTP header name to send the API key.

apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*stringrequired#

User friendly API key name.

apiKeyValuestringapi_key_valuestrapiKeyValueStringApiKeyValuestringApiKeyValue*stringrequired#

API key value.