interface ApiKeyDetailsProperty

Language	Type name
.NET	Amazon.CDK.AWS.DevOpsAgent.CfnService.ApiKeyDetailsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdevopsagent#CfnService_ApiKeyDetailsProperty
Java	software.amazon.awscdk.services.devopsagent.CfnService.ApiKeyDetailsProperty
Python	aws_cdk.aws_devopsagent.CfnService.ApiKeyDetailsProperty
TypeScript	aws-cdk-lib » aws_devopsagent » CfnService » ApiKeyDetailsProperty

API key authentication details.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html

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

Name	Type	Description
apiKeyHeader	string	HTTP header name to send the API key.
apiKeyName	string	User friendly API key name.
apiKeyValue	string	API key value.

---

apiKeyHeader

Type: string

HTTP header name to send the API key.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyheader

---

apiKeyName

Type: string

User friendly API key name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyname

---

apiKeyValue

Type: string

API key value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-devopsagent-service-apikeydetails.html#cfn-devopsagent-service-apikeydetails-apikeyvalue