Skip to content
v2.278.0

ApiKeyDetailsProperty Struct ​

API key authentication details.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_devopsagent as devopsagent

api_key_details_property = devopsagent.CfnService.ApiKeyDetailsProperty(
    api_key_header="apiKeyHeader",
    api_key_name="apiKeyName",
    api_key_value="apiKeyValue"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.devopsagent.*;

ApiKeyDetailsProperty apiKeyDetailsProperty = ApiKeyDetailsProperty.builder()
        .apiKeyHeader("apiKeyHeader")
        .apiKeyName("apiKeyName")
        .apiKeyValue("apiKeyValue")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DevOpsAgent;

var apiKeyDetailsProperty = new ApiKeyDetailsProperty {
    ApiKeyHeader = "apiKeyHeader",
    ApiKeyName = "apiKeyName",
    ApiKeyValue = "apiKeyValue"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

apiKeyDetailsProperty := &ApiKeyDetailsProperty{
	ApiKeyHeader: jsii.String("apiKeyHeader"),
	ApiKeyName: jsii.String("apiKeyName"),
	ApiKeyValue: jsii.String("apiKeyValue"),
}

Properties ​

apiKeyHeaderstringapi_key_headerstrapiKeyHeaderStringApiKeyHeaderstringApiKeyHeader*string required #
HTTP header name to send the API key.
apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*string required #
User friendly API key name.
apiKeyValuestringapi_key_valuestrapiKeyValueStringApiKeyValuestringApiKeyValue*string required #
API key value.