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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.253Z")
 @Stability(value=Stable)
public class CfnConnection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Events::Connection`.

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

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())
                 .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())
         // the properties below are optional
         .description("description")
         .name("name")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnConnection.ApiKeyAuthParametersProperty Contains the API key authorization parameters for the connection.
static interface	CfnConnection.AuthParametersProperty Contains the authorization parameters to use for the connection.
static interface	CfnConnection.BasicAuthParametersProperty Contains the Basic authorization parameters for the connection.
static class	CfnConnection.Builder A fluent builder for CfnConnection.
static interface	CfnConnection.ClientParametersProperty Contains the OAuth authorization parameters to use for the connection.
static interface	CfnConnection.ConnectionHttpParametersProperty Contains additional parameters for the connection.
static interface	CfnConnection.OAuthParametersProperty Contains the OAuth authorization parameters to use for the connection.
static interface	CfnConnection.ParameterProperty Additional query string parameter for the connection.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnection(software.constructs.Construct scope, String id, CfnConnectionProps props) Create a new `AWS::Events::Connection`.
protected	CfnConnection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the connection that was created by the request.
String	getAttrSecretArn() The ARN for the secret created for the connection.
String	getAuthorizationType() The type of authorization to use for the connection.
Object	getAuthParameters() A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the connection to create.
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(CfnConnection.AuthParametersProperty value) A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint.
void	setAuthParameters(IResolvable value) A `CreateConnectionAuthRequestParameters` object that contains the authorization parameters to use to authorize with the endpoint.
void	setDescription(String value) A description for the connection to create.
void	setName(String value) The name for the connection to create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnection

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

CfnConnection

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

CfnConnection

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

Create a new `AWS::Events::Connection`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrSecretArn

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

The ARN for the secret created for the connection.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAuthorizationType

@Stability(value=Stable)
 @NotNull
public String getAuthorizationType()

The type of authorization to use for the connection.

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

setAuthorizationType

@Stability(value=Stable)
public void setAuthorizationType(@NotNull
                                                          String value)

The type of authorization to use for the connection.

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

getAuthParameters

@Stability(value=Stable)
 @NotNull
public Object getAuthParameters()

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

setAuthParameters

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

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

setAuthParameters

@Stability(value=Stable)
public void setAuthParameters(@NotNull
                                                       IResolvable value)

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

getDescription

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

A description for the connection to create.

setDescription

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

A description for the connection to create.

getName

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

The name for the connection to create.

setName

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

The name for the connection to create.