OAuthAuthorizationProps
- class aws_cdk.aws_events.OAuthAuthorizationProps(*, authorization_endpoint, client_id, client_secret, http_method, body_parameters=None, header_parameters=None, query_string_parameters=None)
Bases:
object
Properties for
Authorization.oauth()
.- Parameters:
authorization_endpoint (
str
) – The URL to the authorization endpoint.client_id (
str
) – The client ID to use for OAuth authorization for the connection.client_secret (
SecretValue
) – The client secret associated with the client ID to use for OAuth authorization for the connection.http_method (
HttpMethod
) – The method to use for the authorization request. (Can only choose POST, GET or PUT).body_parameters (
Optional
[Mapping
[str
,HttpParameter
]]) – Additional string parameters to add to the OAuth request body. Default: - No additional parametersheader_parameters (
Optional
[Mapping
[str
,HttpParameter
]]) – Additional string parameters to add to the OAuth request header. Default: - No additional parametersquery_string_parameters (
Optional
[Mapping
[str
,HttpParameter
]]) – Additional string parameters to add to the OAuth request query string. Default: - No additional parameters
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_events as events # http_parameter: events.HttpParameter # secret_value: cdk.SecretValue o_auth_authorization_props = events.OAuthAuthorizationProps( authorization_endpoint="authorizationEndpoint", client_id="clientId", client_secret=secret_value, http_method=events.HttpMethod.POST, # the properties below are optional body_parameters={ "body_parameters_key": http_parameter }, header_parameters={ "header_parameters_key": http_parameter }, query_string_parameters={ "query_string_parameters_key": http_parameter } )
Attributes
- authorization_endpoint
The URL to the authorization endpoint.
- body_parameters
Additional string parameters to add to the OAuth request body.
- Default:
No additional parameters
- client_id
The client ID to use for OAuth authorization for the connection.
- client_secret
The client secret associated with the client ID to use for OAuth authorization for the connection.
- header_parameters
Additional string parameters to add to the OAuth request header.
- Default:
No additional parameters
- http_method
The method to use for the authorization request.
(Can only choose POST, GET or PUT).
- query_string_parameters
Additional string parameters to add to the OAuth request query string.
- Default:
No additional parameters