Package software.amazon.awscdk.services.events

Interface CfnConnectionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-17T05:10:11.282Z")
@Stability(Stable)
public interface CfnConnectionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnConnection.

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.*;
 CfnConnectionProps cfnConnectionProps = CfnConnectionProps.builder()
         .authorizationType("authorizationType")
         // the properties below are optional
         .authParameters(AuthParametersProperty.builder()
                 .apiKeyAuthParameters(ApiKeyAuthParametersProperty.builder()
                         .apiKeyName("apiKeyName")
                         .apiKeyValue("apiKeyValue")
                         .build())
                 .basicAuthParameters(BasicAuthParametersProperty.builder()
                         .password("password")
                         .username("username")
                         .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())
         .description("description")
         .name("name")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConnectionProps.Builder	builder()
String	getAuthorizationType()	The type of authorization to use for the connection.
default Object	getAuthParameters()	A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
default String	getDescription()	A description for the connection to create.
default String	getName()	The name for the connection to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationType

@Stability(Stable)
@NotNull
String getAuthorizationType()

The type of authorization to use for the connection.

OAUTH tokens are refreshed when a 401 or 407 response is returned.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-authorizationtype

getAuthParameters

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

A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the connection to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name for the connection to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-connection.html#cfn-events-connection-name

builder

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

Returns:

a CfnConnectionProps.Builder of CfnConnectionProps