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, KmsKeyIdentifier)

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 APIs, the parameters to use for invoking the API. For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .
KmsKeyIdentifier	The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection. For more information, see Identify and view keys in the Key Management Service Developer 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"
    )
  ),
  KmsKeyIdentifier = "string"
)