interface AuthParametersProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Events.CfnConnection.AuthParametersProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnConnection_AuthParametersProperty |
![]() | software.amazon.awscdk.services.events.CfnConnection.AuthParametersProperty |
![]() | aws_cdk.aws_events.CfnConnection.AuthParametersProperty |
![]() | aws-cdk-lib » aws_events » CfnConnection » AuthParametersProperty |
Tthe authorization parameters to use for the connection.
Example
// 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 authParametersProperty: events.CfnConnection.AuthParametersProperty = {
apiKeyAuthParameters: {
apiKeyName: 'apiKeyName',
apiKeyValue: 'apiKeyValue',
},
basicAuthParameters: {
password: 'password',
username: 'username',
},
connectivityParameters: {
resourceParameters: {
resourceConfigurationArn: 'resourceConfigurationArn',
// the properties below are optional
resourceAssociationArn: 'resourceAssociationArn',
},
},
invocationHttpParameters: {
bodyParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
headerParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
queryStringParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
},
oAuthParameters: {
authorizationEndpoint: 'authorizationEndpoint',
clientParameters: {
clientId: 'clientId',
clientSecret: 'clientSecret',
},
httpMethod: 'httpMethod',
// the properties below are optional
oAuthHttpParameters: {
bodyParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
headerParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
queryStringParameters: [{
key: 'key',
value: 'value',
// the properties below are optional
isValueSecret: false,
}],
},
},
};
Properties
Name | Type | Description |
---|---|---|
api | IResolvable | Api | The API Key parameters to use for authorization. |
basic | IResolvable | Basic | The authorization parameters for Basic authorization. |
connectivity | IResolvable | Connectivity | For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint. |
invocation | IResolvable | Connection | Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint. |
o | IResolvable | OAuth | The OAuth parameters to use for authorization. |
apiKeyAuthParameters?
Type:
IResolvable
|
Api
(optional)
The API Key parameters to use for authorization.
basicAuthParameters?
Type:
IResolvable
|
Basic
(optional)
The authorization parameters for Basic authorization.
connectivityParameters?
Type:
IResolvable
|
Connectivity
(optional)
For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.
For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .
invocationHttpParameters?
Type:
IResolvable
|
Connection
(optional)
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
oAuthParameters?
Type:
IResolvable
|
OAuth
(optional)
The OAuth parameters to use for authorization.