Package software.amazon.awscdk.services.events

Class CfnConnection

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.events.CfnConnection
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.941Z") @Stability(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();

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

    • 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) @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(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(Stable) @NotNull public Object getAuthParameters()
      A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

    • setAuthParameters

      @Stability(Stable) public void setAuthParameters(@NotNull IResolvable value)
      A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.

    • setAuthParameters

      @Stability(Stable) public void setAuthParameters(@NotNull CfnConnection.AuthParametersProperty value)
      A CreateConnectionAuthRequestParameters object that contains 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.

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