Skip to content

Latest commit

 

History

History
115 lines (95 loc) · 6.67 KB

confluent_access_point.md

File metadata and controls

115 lines (95 loc) · 6.67 KB
page_title subcategory description
confluent_access_point Resource - terraform-provider-confluent

confluent_access_point Resource

General Availability

confluent_access_point provides a Access Point resource that enables creating, editing, and deleting Access Points on Confluent Cloud.

Example Usage

resource "confluent_environment" "development" {
  display_name = "Development"
}

resource "confluent_access_point" "aws" {
  display_name = "access_point"
  environment {
    id = confluent_environment.development.id
  }
  gateway {
    id = confluent_network.main.gateway[0].id
  }
  aws_egress_private_link_endpoint {
    vpc_endpoint_service_name = "com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000"
  }
}

resource "confluent_access_point" "azure" {
  display_name = "access_point"
  environment {
    id = confluent_environment.development.id
  }
  gateway {
    id = confluent_network.main.gateway[0].id
  }
  azure_egress_private_link_endpoint {
    private_link_service_resource_id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3"
    private_link_subresource_name = "sqlServer"
  }
}

resource "confluent_access_point" "gcp" {
  display_name = "access_point"
  environment {
    id = confluent_environment.development.id
  }
  gateway {
    id = confluent_network.main.gateway[0].id
  }
  gcp_egress_private_service_connect_endpoint {
    private_service_connect_endpoint_target = "projects/example-project/regions/us-central1/serviceAttachments/my-service-attachment"
  }
}

Argument Reference

The following arguments are supported:

  • display_name - (Optional String) The name of the Access Point.
  • environment (Required Configuration Block) supports the following:
    • id - (Required String) The ID of the Environment that the Access Point belongs to, for example, env-abc123.
  • gateway (Required Configuration Block) supports the following:
    • id - (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
  • aws_egress_private_link_endpoint (Optional Configuration Block) supports the following:
    • vpc_endpoint_service_name - (Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    • enable_high_availability - (Optional Boolean) Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
  • azure_egress_private_link_endpoint (Optional Configuration Block) supports the following:
    • private_link_service_resource_id - (Required String) Resource ID of the Azure Private Link service.
    • private_link_subresource_name - (Optional String) Name of the subresource for the Private Endpoint to connect to.
  • gcp_egress_private_service_connect_endpoint (Optional Configuration Block) supports the following:
    • private_service_connect_endpoint_target - (Required String) URI of the service attachment for the published service that the Private Service Connect Endpoint connects to, or "ALL_GOOGLE_APIS" or "all-google-apis" for global Google APIs.

Attributes Reference

In addition to the preceding arguments, the following attributes are exported:

  • id - (Required String) The ID of the Access Point, for example, dnsrec-abc123.
  • aws_egress_private_link_endpoint (Optional Configuration Block) supports the following:
    • vpc_endpoint_id - (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    • vpc_endpoint_dns_name - (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
  • aws_private_network_interface (Optional Configuration Block) supports the following:
    • network_interfaces - (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    • account - (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
  • azure_egress_private_link_endpoint (Optional Configuration Block) supports the following:
    • private_endpoint_resource_id - (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    • private_endpoint_domain - (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    • private_endpoint_ip_address - (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    • private_endpoint_custom_dns_config_domains - (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
  • gcp_egress_private_service_connect_endpoint (Optional Configuration Block) supports the following:
    • private_service_connect_endpoint_ip_address - (Required String) IP address of the Private Service Connect Endpoint that is connected to the endpoint target.
    • private_service_connect_endpoint_connection_id - (Required String) Connection ID of the Private Service Connect Endpoint that is connected to the endpoint target.
    • private_service_connect_endpoint_name - (Required String) Name of the Private Service Connect Endpoint that is connected to the endpoint target.

Import

-> Note: CONFLUENT_CLOUD_API_KEY and CONFLUENT_CLOUD_API_SECRET environment variables must be set before importing a Access Point.

You can import a Access Point by using Environment ID and Access Point ID, in the format <Environment ID>/<Access Point ID>. The following example shows how to import a Access Point:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ terraform import confluent_access_point.main env-abc123/ap-abc123

!> Warning: Do not forget to delete terminal command history afterwards for security purposes.