Update Connection

eventbridge_update_connection

R Documentation

Updates settings for a connection

Description

Updates settings for a connection.

Usage

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

Arguments

Name

[required] The name of the connection to update.

Description

A description for the connection.

AuthorizationType

The type of authorization to use for the connection.

AuthParameters

The authorization parameters to use for the connection.

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"
  ),
  LastAuthorizedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$update_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"
    )
  )
)