[ aws . continuum ]

update-integration

Description

Rotates the credentials used by an Amazon S3 integration. Only S3 integrations can be updated; GitHub integrations cannot be modified. The integration’s name, provider type, and bucket remain fixed.

The caller must have iam:PassRole permission for the supplied role, including when only the external ID changes. Continuum verifies that the role can be assumed with the requested external ID and can access the existing bucket before saving both credentials atomically. Omitting externalId preserves its current value. Repeating both current credentials leaves updatedAt unchanged, but still requires authorization and access validation.

See also: AWS API Documentation

Synopsis

  update-integration
--integration-id <value>
--provider-configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--integration-id (string) [required]

The unique identifier of the S3 integration to update.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

--provider-configuration (tagged union structure) [required]

The provider-specific changes to apply. The member must match the integration’s provider type, and only S3 integrations can be updated.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.

s3 -> (structure)

Replacement credentials for a customer-managed S3 integration.

roleArn -> (string) [required]

The role to use. Supply the current role when rotating only the external ID. The caller must be allowed to pass this exact role to Continuum.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@/-]+

externalId -> (string)

The replacement external ID used when assuming the supplied role. If omitted, the existing external ID is preserved. This value is sensitive and is never included in the public integration response.

Constraints:

  • min: 2
  • max: 1224
  • pattern: [\w+=,.@:\/-]+

Shorthand Syntax:

s3={roleArn=string,externalId=string}

JSON Syntax:

{
  "s3": {
    "roleArn": "string",
    "externalId": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

integrationId -> (string)

The unique identifier for an Integration resource.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

integrationArn -> (string)

The Amazon Resource Name (ARN) of an Integration resource, of the form arn:{partition}:continuum:{region}:{account}:integrations/{integrationId}.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:continuum:[a-z0-9-]+:[0-9]{12}:integrations/[a-z0-9]+

name -> (string)

The name for an integration.

Constraints:

  • min: 1
  • max: 255

integrationType -> (string)

The immutable provider type for an integration.

Possible values:

  • GITHUB
  • GITLAB
  • S3

providerDetails -> (tagged union structure)

Provider-specific details for an integration. Only one member will be present.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: github, gitlab, s3.

github -> (structure)

Details for a GitHub.com integration.

organizationName -> (string)

The name of the GitHub organization associated with the integration.

Constraints:

  • min: 1
  • max: 39
  • pattern: [a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?

gitlab -> (structure)

Details for a GitLab integration.

instanceUrl -> (string) [required]

The HTTPS base URL of the GitLab instance.

Constraints:

  • min: 9
  • max: 2083
  • pattern: https://\S+

targetType -> (string) [required]

Whether the integration targets a group or a single project.

Possible values:

  • GROUP
  • PROJECT

targetPath -> (string) [required]

The group or project path the integration targets.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [A-Za-z0-9][A-Za-z0-9._\-]*(/[A-Za-z0-9][A-Za-z0-9._\-]*)*

tokenRotation -> (string) [required]

How the integration’s access token is rotated. AUTOMATIC only when the pasted token had the self-rotate scope and rotation was opted in at installation time.

Possible values:

  • AUTOMATIC
  • NONE

expiresAt -> (timestamp)

The expiry of the stored access token, for non-rotating tokens only. A rotated token’s original expiry is stale, so this is omitted when tokenRotation is AUTOMATIC.

s3 -> (structure)

Public details for a customer-managed S3 integration.

bucket -> (string) [required]

Customer-managed S3 bucket name.

Constraints:

  • min: 3
  • max: 63
  • pattern: [a-z0-9][a-z0-9.\-]{1,61}[a-z0-9]

roleArn -> (string) [required]

IAM role assumed by Continuum to read a customer-managed S3 integration.

Constraints:

  • min: 1
  • max: 1011
  • pattern: arn:[a-z0-9-]+:iam::[0-9]{12}:role/[a-zA-Z0-9_+=,.@/-]+

createdAt -> (timestamp)

When the integration was created.

updatedAt -> (timestamp)

When the integration was last updated.