Package software.amazon.awscdk.services.events

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnection.AuthParametersProperty.Builder	builder()
default Object	getApiKeyAuthParameters()	The API Key parameters to use for authorization.
default Object	getBasicAuthParameters()	The authorization parameters for Basic authorization.
default Object	getConnectivityParameters()	For private OAuth authentication endpoints.
default Object	getInvocationHttpParameters()	Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
default Object	getOAuthParameters()	The OAuth parameters to use for authorization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiKeyAuthParameters

@Stability(Stable)
@Nullable
default Object getApiKeyAuthParameters()

The API Key parameters to use for authorization.

Returns union: either IResolvable or CfnConnection.ApiKeyAuthParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-apikeyauthparameters

getBasicAuthParameters

@Stability(Stable)
@Nullable
default Object getBasicAuthParameters()

The authorization parameters for Basic authorization.

Returns union: either IResolvable or CfnConnection.BasicAuthParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-basicauthparameters

getConnectivityParameters

@Stability(Stable)
@Nullable
default Object 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 .

Returns union: either IResolvable or CfnConnection.ConnectivityParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-connectivityparameters

getInvocationHttpParameters

@Stability(Stable)
@Nullable
default Object getInvocationHttpParameters()

Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

Returns union: either IResolvable or CfnConnection.ConnectionHttpParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-invocationhttpparameters

getOAuthParameters

@Stability(Stable)
@Nullable
default Object getOAuthParameters()

The OAuth parameters to use for authorization.

Returns union: either IResolvable or CfnConnection.OAuthParametersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-connection-authparameters.html#cfn-events-connection-authparameters-oauthparameters

builder

@Stability(Stable)
static CfnConnection.AuthParametersProperty.Builder builder()

Returns:

a CfnConnection.AuthParametersProperty.Builder of CfnConnection.AuthParametersProperty