Skip to content
v2.277.0

ApiKeyAuthParametersProperty Struct ​

The API key authorization parameters for the connection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const apiKeyAuthParametersProperty: events.CfnConnection.ApiKeyAuthParametersProperty = {
  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_events as events

api_key_auth_parameters_property = events.CfnConnection.ApiKeyAuthParametersProperty(
    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.events.*;

ApiKeyAuthParametersProperty apiKeyAuthParametersProperty = ApiKeyAuthParametersProperty.builder()
        .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.Events;

var apiKeyAuthParametersProperty = new ApiKeyAuthParametersProperty {
    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"

apiKeyAuthParametersProperty := &ApiKeyAuthParametersProperty{
	ApiKeyName: jsii.String("apiKeyName"),
	ApiKeyValue: jsii.String("apiKeyValue"),
}

Properties ​

apiKeyNamestringapi_key_namestrapiKeyNameStringApiKeyNamestringApiKeyName*stringrequired#
The name of the API key to use for authorization.
apiKeyValuestringapi_key_valuestrapiKeyValueStringApiKeyValuestringApiKeyValue*stringrequired#
The value for the API key to use for authorization.