Create Connection

eventbridge_create_connection

R Documentation

Creates a connection

Description

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.

Usage

eventbridge_create_connection(Name, Description, AuthorizationType,
  AuthParameters, InvocationConnectivityParameters)

Arguments

Name

[required] The name for the connection to create.

Description

A description for the connection to create.

AuthorizationType

[required] The type of authorization to use for the connection.

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

AuthParameters

[required] The authorization parameters to use to authorize with the endpoint.

You must include only authorization parameters for the AuthorizationType you specify.

InvocationConnectivityParameters

For connections to private resource endpoints, the parameters to use for invoking the resource endpoint.

For more information, see Connecting to private resources in the Amazon EventBridge User Guide .

Value

A list with the following syntax:

list(
  ConnectionArn = "string",
  ConnectionState = "CREATING"|"UPDATING"|"DELETING"|"AUTHORIZED"|"DEAUTHORIZED"|"AUTHORIZING"|"DEAUTHORIZING"|"ACTIVE"|"FAILED_CONNECTIVITY",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_connection(
  Name = "string",
  Description = "string",
  AuthorizationType = "BASIC"|"OAUTH_CLIENT_CREDENTIALS"|"API_KEY",
  AuthParameters = list(
    BasicAuthParameters = list(
      Username = "string",
      Password = "string"
    ),
    OAuthParameters = list(
      ClientParameters = list(
        ClientID = "string",
        ClientSecret = "string"
      ),
      AuthorizationEndpoint = "string",
      HttpMethod = "GET"|"POST"|"PUT",
      OAuthHttpParameters = list(
        HeaderParameters = list(
          list(
            Key = "string",
            Value = "string",
            IsValueSecret = TRUE|FALSE
          )
        ),
        QueryStringParameters = list(
          list(
            Key = "string",
            Value = "string",
            IsValueSecret = TRUE|FALSE
          )
        ),
        BodyParameters = list(
          list(
            Key = "string",
            Value = "string",
            IsValueSecret = TRUE|FALSE
          )
        )
      )
    ),
    ApiKeyAuthParameters = list(
      ApiKeyName = "string",
      ApiKeyValue = "string"
    ),
    InvocationHttpParameters = list(
      HeaderParameters = list(
        list(
          Key = "string",
          Value = "string",
          IsValueSecret = TRUE|FALSE
        )
      ),
      QueryStringParameters = list(
        list(
          Key = "string",
          Value = "string",
          IsValueSecret = TRUE|FALSE
        )
      ),
      BodyParameters = list(
        list(
          Key = "string",
          Value = "string",
          IsValueSecret = TRUE|FALSE
        )
      )
    ),
    ConnectivityParameters = list(
      ResourceParameters = list(
        ResourceConfigurationArn = "string"
      )
    )
  ),
  InvocationConnectivityParameters = list(
    ResourceParameters = list(
      ResourceConfigurationArn = "string"
    )
  )
)