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, IConnectionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:38.841Z") @Stability(Stable) public class CfnConnection extends CfnResource implements IInspectable, IConnectionRef
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())
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .name("name")
         .build();

See Also:

  • 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

    • fromConnectionArn

      @Stability(Stable) @NotNull public static IConnectionRef fromConnectionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IConnectionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromConnectionName

      @Stability(Stable) @NotNull public static IConnectionRef fromConnectionName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String connectionName)
      Creates a new IConnectionRef from a connectionName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      connectionName - This parameter is required.

    • 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.

    • getAttrArnForPolicy

      @Stability(Stable) @NotNull public String getAttrArnForPolicy()
      Returns the Amazon Resource Name (ARN) of a connection in resource format, so it can be used in the Resource element of IAM permission policy statements.

      For more information, see Resource types defined by Amazon EventBridge in the Service Authorization Reference .

      For example, the following resource defines an IAM policy that grants permission to update a specific connection.

      Resources: ExamplePolicy: Type: AWS::IAM::Policy Properties: PolicyName: ExamplePolicy PolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Action: - events:UpdateConnection Resource: - !GetAtt myConnection.ArnForPolicy

    • 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

    • getConnectionRef

      @Stability(Stable) @NotNull public ConnectionReference getConnectionRef()
      A reference to a Connection resource.
      Specified by:
      getConnectionRef in interface IConnectionRef

    • 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.

      Returns union: either IResolvable or CfnConnection.AuthParametersProperty

    • 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.

      Returns union: either IResolvable or CfnConnection.InvocationConnectivityParametersProperty

    • 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.

    • getKmsKeyIdentifier

      @Stability(Stable) @Nullable public String getKmsKeyIdentifier()
      The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)
      The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection.

    • 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.