Package software.amazon.awscdk.services.events

Interface OAuthAuthorizationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OAuthAuthorizationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.025Z")
@Stability(Stable)
public interface OAuthAuthorizationProps
extends software.amazon.jsii.JsiiSerializable

Properties for Authorization.oauth().

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.events.*;
 HttpParameter httpParameter;
 SecretValue secretValue;
 OAuthAuthorizationProps oAuthAuthorizationProps = OAuthAuthorizationProps.builder()
         .authorizationEndpoint("authorizationEndpoint")
         .clientId("clientId")
         .clientSecret(secretValue)
         .httpMethod(HttpMethod.POST)
         // the properties below are optional
         .bodyParameters(Map.of(
                 "bodyParametersKey", httpParameter))
         .headerParameters(Map.of(
                 "headerParametersKey", httpParameter))
         .queryStringParameters(Map.of(
                 "queryStringParametersKey", httpParameter))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OAuthAuthorizationProps.Builder	A builder for OAuthAuthorizationProps
static final class	OAuthAuthorizationProps.Jsii$Proxy	An implementation for OAuthAuthorizationProps

Method Summary

Modifier and Type	Method	Description
static OAuthAuthorizationProps.Builder	builder()
String	getAuthorizationEndpoint()	The URL to the authorization endpoint.
default Map<String,HttpParameter>	getBodyParameters()	Additional string parameters to add to the OAuth request body.
String	getClientId()	The client ID to use for OAuth authorization for the connection.
SecretValue	getClientSecret()	The client secret associated with the client ID to use for OAuth authorization for the connection.
default Map<String,HttpParameter>	getHeaderParameters()	Additional string parameters to add to the OAuth request header.
HttpMethod	getHttpMethod()	The method to use for the authorization request.
default Map<String,HttpParameter>	getQueryStringParameters()	Additional string parameters to add to the OAuth request query string.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationEndpoint

@Stability(Stable)
@NotNull
String getAuthorizationEndpoint()

The URL to the authorization endpoint.

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The client ID to use for OAuth authorization for the connection.

getClientSecret

@Stability(Stable)
@NotNull
SecretValue getClientSecret()

The client secret associated with the client ID to use for OAuth authorization for the connection.

getHttpMethod

@Stability(Stable)
@NotNull
HttpMethod getHttpMethod()

The method to use for the authorization request.

(Can only choose POST, GET or PUT).

getBodyParameters

@Stability(Stable)
@Nullable
default Map<String,HttpParameter> getBodyParameters()

Additional string parameters to add to the OAuth request body.

Default: - No additional parameters

getHeaderParameters

@Stability(Stable)
@Nullable
default Map<String,HttpParameter> getHeaderParameters()

Additional string parameters to add to the OAuth request header.

Default: - No additional parameters

getQueryStringParameters

@Stability(Stable)
@Nullable
default Map<String,HttpParameter> getQueryStringParameters()

Additional string parameters to add to the OAuth request query string.

Default: - No additional parameters

builder

@Stability(Stable)
static OAuthAuthorizationProps.Builder builder()

Returns:

a OAuthAuthorizationProps.Builder of OAuthAuthorizationProps