aws.vpc.create_vpc_endpoint ​
Call AWS EC2 CreateVpcEndpoint using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID used for field resolution and connection scoping. |
connection_uuid | uuid | Yes | — | AWS CloudConnection UUID for the target VPC account, scoped to the caller organization. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS API endpoint region override; omit to use the connection or SDK default. |
dry_run | boolean | No | — | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is Dry... |
vpc_endpoint_type | string | No | — | The type of endpoint. Default: Gateway |
vpc_id | string | Yes | — | The ID of the VPC. |
service_name | string | No | — | The name of the endpoint service. |
policy_document | string | No | — | (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a de... |
route_table_ids | list | No | — | (Gateway endpoint) The route table IDs. |
subnet_ids | list | No | — | (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. |
security_group_ids | list | No | — | (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. |
ip_address_type | string | No | — | The IP address type for the endpoint. |
dns_options | json | No | — | The DNS options for the endpoint. |
client_token | string | No | — | Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. |
private_dns_enabled | boolean | No | — | (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for t... |
tag_specifications | list | No | — | The tags to associate with the endpoint. |
subnet_configurations | list | No | — | The subnet configurations for the endpoint. |
service_network_arn | string | No | — | The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network. |
resource_configuration_arn | string | No | — | The Amazon Resource Name (ARN) of a resource configuration that will be associated with the VPC endpoint of type resource. |
service_region | string | No | — | The Region where the service is hosted. The default is the current Region. |
provider_native_request | json | No | — | Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
connection_uuid | uuid | No | — | AWS CloudConnection UUID echoed from input. |
region | string | No | — | AWS API endpoint region used. |
service | string | No | — | AWS boto3 service/client name. |
operation | string | No | — | AWS API operation invoked. |
request_id | string | No | — | AWS request ID when available. |
response | json | No | — | Sanitized provider response object. |
items | list | No | — | Primary response item list when the API returns a collection. |
result_count | integer | No | — | Count of primary response items. |
next_page_token | string | No | — | Pagination token for the next page. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if engine supplies one. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.vpc.create_vpc_endpoint",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"vpc_id": "value"
}
}