Package software.amazon.awscdk.services.events

Class CfnConnection

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.events.CfnConnection

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-12T12:32:03.093Z")
@Stability(Stable)
public class CfnConnection
extends CfnResource
implements IInspectable

Creates a connection.

A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide .

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.*;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .authorizationType("authorizationType")
         .authParameters(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())
         .description("description")
         .invocationConnectivityParameters(InvocationConnectivityParametersProperty.builder()
                 .resourceParameters(ResourceParametersProperty.builder()
                         .resourceConfigurationArn("resourceConfigurationArn")
                         // the properties below are optional
                         .resourceAssociationArn("resourceAssociationArn")
                         .build())
                 .build())
         .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	Class	Description
static interface	CfnConnection.ApiKeyAuthParametersProperty	The API key authorization parameters for the connection.
static interface	CfnConnection.AuthParametersProperty	Tthe authorization parameters to use for the connection.
static interface	CfnConnection.BasicAuthParametersProperty	The Basic authorization parameters for the connection.
static final class	CfnConnection.Builder	A fluent builder for CfnConnection.
static interface	CfnConnection.ClientParametersProperty	The OAuth authorization parameters to use for the connection.
static interface	CfnConnection.ConnectionHttpParametersProperty	Any additional parameters for the connection.
static interface	CfnConnection.ConnectivityParametersProperty	If you specify a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.
static interface	CfnConnection.InvocationConnectivityParametersProperty	For connections to private APIs, the parameters to use for invoking the API.
static interface	CfnConnection.OAuthParametersProperty	Contains the OAuth authorization parameters to use for the connection.
static interface	CfnConnection.ParameterProperty	Any additional query string parameter for the connection.
static interface	CfnConnection.ResourceParametersProperty	The parameters for EventBridge to use when invoking the resource endpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)
	CfnConnection(software.constructs.Construct scope, String id)
	CfnConnection(software.constructs.Construct scope, String id, CfnConnectionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The ARN of the connection that was created by the request.
String	getAttrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn()	For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
String	getAttrInvocationConnectivityParametersResourceParametersResourceAssociationArn()	For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.
String	getAttrSecretArn()	The ARN for the secret created for the connection.
String	getAuthorizationType()	The type of authorization to use for the connection.
Object	getAuthParameters()	The authorization parameters to use to authorize with the endpoint.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description for the connection to create.
Object	getInvocationConnectivityParameters()	For connections to private APIs, the parameters to use for invoking the API.
String	getName()	The name for the connection to create.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthorizationType(String value)	The type of authorization to use for the connection.
void	setAuthParameters(IResolvable value)	The authorization parameters to use to authorize with the endpoint.
void	setAuthParameters(CfnConnection.AuthParametersProperty value)	The authorization parameters to use to authorize with the endpoint.
void	setDescription(String value)	A description for the connection to create.
void	setInvocationConnectivityParameters(IResolvable value)	For connections to private APIs, the parameters to use for invoking the API.
void	setInvocationConnectivityParameters(CfnConnection.InvocationConnectivityParametersProperty value)	For connections to private APIs, the parameters to use for invoking the API.
void	setName(String value)	The name for the connection to create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnConnection

protected CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)

CfnConnection

protected CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnConnection

@Stability(Stable)
public CfnConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnConnectionProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnConnection

@Stability(Stable)
public CfnConnection(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of the connection that was created by the request.

getAttrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn

@Stability(Stable)
@NotNull
public String getAttrAuthParametersConnectivityParametersResourceParametersResourceAssociationArn()

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

The value of this property is set by EventBridge . Any value you specify in your template is ignored.

getAttrInvocationConnectivityParametersResourceParametersResourceAssociationArn

@Stability(Stable)
@NotNull
public String getAttrInvocationConnectivityParametersResourceParametersResourceAssociationArn()

For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API's resource configuration.

The value of this property is set by EventBridge . Any value you specify in your template is ignored.

getAttrSecretArn

@Stability(Stable)
@NotNull
public String getAttrSecretArn()

The ARN for the secret created for the connection.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthorizationType

@Stability(Stable)
@Nullable
public String getAuthorizationType()

The type of authorization to use for the connection.

setAuthorizationType

@Stability(Stable)
public void setAuthorizationType(@Nullable
 String value)

The type of authorization to use for the connection.

getAuthParameters

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

The authorization parameters to use to authorize with the endpoint.

setAuthParameters

@Stability(Stable)
public void setAuthParameters(@Nullable
 IResolvable value)

The authorization parameters to use to authorize with the endpoint.

setAuthParameters

@Stability(Stable)
public void setAuthParameters(@Nullable
 CfnConnection.AuthParametersProperty value)

The authorization parameters to use to authorize with the endpoint.

getDescription

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

A description for the connection to create.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description for the connection to create.

getInvocationConnectivityParameters

@Stability(Stable)
@Nullable
public Object getInvocationConnectivityParameters()

For connections to private APIs, the parameters to use for invoking the API.

setInvocationConnectivityParameters

@Stability(Stable)
public void setInvocationConnectivityParameters(@Nullable
 IResolvable value)

For connections to private APIs, the parameters to use for invoking the API.

setInvocationConnectivityParameters

@Stability(Stable)
public void setInvocationConnectivityParameters(@Nullable
 CfnConnection.InvocationConnectivityParametersProperty value)

For connections to private APIs, the parameters to use for invoking the API.

getName

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

The name for the connection to create.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name for the connection to create.