Manage an AWS Provider Integration in Confluent Cloud¶
After you create a provider integration in Confluent Cloud with your cloud service provider, you can manage the provider integration in Confluent Cloud using the Confluent Cloud Console, Confluent CLI, and Confluent Cloud APIs. The following sections describe how to list, describe, update, and delete AWS provider integrations using each method.
List AWS provider integrations¶
You can list all AWS provider integrations in an environment using the Confluent Cloud Console, Confluent CLI, or Confluent Cloud APIs.
- Open the Confluent Cloud Console at https://confluent.cloud.
- Go the the environment where you want to list integrations for.
- Select Integrations > Provider Integrations.
The Confluent Cloud Console displays a list of all provider integrations in the environment.
To list all AWS provider integrations in an environment, use the
confluent provider-integration list
CLI command:
confluent provider-integration list
For details on the confluent provider-integration list
CLI command,
see confluent provider-integration list
in the Confluent CLI Command Reference.
To list all AWS provider integrations in an environment, use the GET request:
curl --request GET 'https://api.confluent.cloud/pim/v1/integrations?provider=AWS&environment={environment-id}' \
--header 'Authorization: Basic <base64-encoded-key-and-secret>' | jq
Replace {environment-id} with your environment ID and <base64-encoded-key-and-secret> with your API key and secret encoded in base64.
For details on using the Provider Integration API to list AWS provider integrations, see List of Integrations [Integrations (pim/v1)] in the Confluent Cloud APIs Reference.
Describe a AWS provider integration¶
You can describe a AWS provider integration in an environment using the Confluent Cloud Console, Confluent CLI, or Confluent Cloud APIs.
To see the details of a AWS provider integration using the Confluent Cloud Console:
- Open the Confluent Cloud Console at https://confluent.cloud.
- Go the the environment where you want to list integrations for.
- Select Integrations > Provider Integrations.
- Select the integration to view its details.
To see the details of a AWS provider integration using the Confluent CLI,
use the confluent provider-integration describe
CLI command:
confluent provider-integration describe --id <integration-id>
Replace <integration-id> with the ID of the integration you want to describe.
For details on the confluent provider-integration describe
CLI command,
see confluent provider-integration describe
in the Confluent CLI Command Reference.
To see the details of a AWS provider integration using the REST API, use the GET request:
- curl –request GET
- –url ‘https://api.confluent.cloud/pim/v1/integrations/{id}?environment={environment-id}’ –header ‘Authorization: Basic <base64-encoded-key-and-secret>’ | jq
Replace {id} with the integration ID and {environment-id} with your environment ID.
Update a AWS provider integration¶
You can update a AWS provider integration in an environment using the Confluent Cloud Console, Confluent CLI, or Confluent Cloud APIs.
- Open the Confluent Cloud Console at https://confluent.cloud.
- Go the the environment where you want to list integrations for.
- Select Integrations > Provider Integrations.
- Select the integration to update.
- Click Edit.
- Update the desired fields and click Save.
The Confluent Cloud Console displays the updated integration details.
To update a AWS provider integration using the Confluent CLI, use the
confluent provider-integration update
CLI command:
confluent provider-integration update \
--id <integration-id> \
--config <config-file>
Replace <integration-id> with the ID of the integration you want to update and <config-file> with the path to the configuration file you want to use.
For details on the confluent provider-integration update
CLI command,
see confluent provider-integration update
in the Confluent CLI Command Reference.
Delete a AWS provider integration¶
You can delete a AWS provider integration in an environment using the Confluent Cloud Console, Confluent CLI, or Confluent Cloud APIs.
Note
A delete request fails if any Confluent Cloud workloads are using the provider integration.
To delete a AWS provider integration using the Confluent Cloud Console:
- Open the Confluent Cloud Console at https://confluent.cloud.
- Go the the environment where you want to delete the integration.
- Select Integrations > Provider Integrations.
- Select the integration to delete.
- Click Delete.
The Confluent Cloud Console displays a confirmation message.
To delete a AWS provider integration using the Confluent CLI, run the
confluent provider-integration delete
CLI command:
confluent provider-integration delete \
--id <integration-id>
Replace <integration-id> with the ID of the integration you want to delete.
For details on the confluent provider-integration delete
CLI command,
see confluent provider-integration delete
in the Confluent CLI Command Reference.
To delete a AWS provider integration using the REST API, use the DELETE request:
curl --request DELETE \
--url 'https://api.confluent.cloud/pim/v1/integrations/{id}?environment={environment-id}' \
--header 'Authorization: Basic <base64-encoded-key-and-secret>' | jq
Replace {id} with the integration ID and {environment-id} with your environment ID.
For details on using the Provider Integration API to delete a AWS provider integration, see Delete an Integration [Integrations (pim/v1)] in the Confluent Cloud APIs Reference.