Interface CfnConnection.AuthParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConnection.AuthParametersProperty.Jsii$Proxy
- Enclosing class:
CfnConnection
@Stability(Stable)
public static interface CfnConnection.AuthParametersProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.events.*; AuthParametersProperty authParametersProperty = AuthParametersProperty.builder() .apiKeyAuthParameters(ApiKeyAuthParametersProperty.builder() .apiKeyName("apiKeyName") .apiKeyValue("apiKeyValue") .build()) .basicAuthParameters(BasicAuthParametersProperty.builder() .password("password") .username("username") .build()) .connectivityParameters(ConnectivityParametersProperty.builder() .resourceParameters(ResourceParametersProperty.builder() .resourceConfigurationArn("resourceConfigurationArn") // the properties below are optional .resourceAssociationArn("resourceAssociationArn") .build()) .build()) .invocationHttpParameters(ConnectionHttpParametersProperty.builder() .bodyParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .headerParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .queryStringParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .build()) .oAuthParameters(OAuthParametersProperty.builder() .authorizationEndpoint("authorizationEndpoint") .clientParameters(ClientParametersProperty.builder() .clientId("clientId") .clientSecret("clientSecret") .build()) .httpMethod("httpMethod") // the properties below are optional .oAuthHttpParameters(ConnectionHttpParametersProperty.builder() .bodyParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .headerParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .queryStringParameters(List.of(ParameterProperty.builder() .key("key") .value("value") // the properties below are optional .isValueSecret(false) .build())) .build()) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConnection.AuthParametersProperty
static final class
An implementation forCfnConnection.AuthParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The API Key parameters to use for authorization.default Object
The authorization parameters for Basic authorization.default Object
For private OAuth authentication endpoints.default Object
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.default Object
The OAuth parameters to use for authorization.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApiKeyAuthParameters
The API Key parameters to use for authorization.- See Also:
-
getBasicAuthParameters
The authorization parameters for Basic authorization.- See Also:
-
getConnectivityParameters
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 .
- See Also:
-
getInvocationHttpParameters
Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.- See Also:
-
getOAuthParameters
The OAuth parameters to use for authorization.- See Also:
-
builder
-