@itentialopensource/adapter-aws_ec2
Version:
This adapter integrates with system described as: Aws_Ec2.
477 lines • 14.8 kB
JSON
{
"$id": "schema.json",
"type": "object",
"schema": "http://json-schema.org/draft-07/schema#",
"translate": true,
"dynamicfields": true,
"properties": {
"ph_request_type": {
"type": "string",
"description": "type of request (internal to adapter)",
"default": "describeVpnGateways",
"enum": [
"describeVpnGateways",
"describeVpnConnections",
"createVpnGateway",
"createVpnConnection",
"createVpnConnectionRoute",
"modifyVpnConnection",
"attachVpnGateway",
"detachVpnGateway",
"deleteVpnGateway",
"deleteVpnConnection",
"deleteVpnConnectionRoute",
"describeClientVpnConnections",
"describeClientVpnRoutes",
"describeClientVpnEndpoints",
"describeClientVpnTargetNetworks",
"describeClientVpnAuthorizationRules",
"createClientVpnRoute",
"createClientVpnEndpoint",
"exportClientVpnClientConfiguration",
"exportClientVpnClientCertificateRevocationList",
"importClientVpnClientCertificateRevocationList",
"modifyClientVpnEndpoint",
"associateClientVpnTargetNetwork",
"authorizeClientVpnIngress",
"disassociateClientVpnTargetNetwork",
"revokeClientVpnIngress",
"terminateClientVpnConnections",
"deleteClientVpnEndpoint",
"deleteClientVpnRoute"
],
"external_name": "ph_request_type"
},
"vpnConnectionId": {
"description": "The ID of the VPN connection.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "VpnConnectionId"
},
"transitGatewayId": {
"description": "The ID of the transit gateway.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "TransitGatewayId"
},
"vpnGatewayId": {
"description": "The ID of the virtual private gateway at the AWS side of the VPN connection.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "VpnGatewayId"
},
"clientVpnEndpointId": {
"description": "The ID of the Client VPN endpoint to which the client is connected.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ClientVpnEndpointId"
},
"connectionId": {
"description": "The ID of the client connection to be terminated.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ConnectionId"
},
"dryRun": {
"description": "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...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "DryRun"
},
"action": {
"description": "",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Action"
},
"version": {
"description": "",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Version"
},
"username": {
"description": "The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user ha...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Username"
},
"targetNetworkCidr": {
"description": "The IPv4 address range, in CIDR notation, of the network for which access is being removed.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "TargetNetworkCidr"
},
"accessGroupId": {
"description": "The ID of the Active Directory group for which to revoke access.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AccessGroupId"
},
"revokeAllGroups": {
"description": "Indicates whether access should be revoked for all clients.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "RevokeAllGroups"
},
"certificateRevocationList": {
"description": "The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide .",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "CertificateRevocationList"
},
"serverCertificateArn": {
"description": "The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ServerCertificateArn"
},
"connectionLogOptionsEnabled": {
"description": "Describes the client connection logging options for the Client VPN endpoint.\nIndicates whether connection logging is enabled.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ConnectionLogOptions.Enabled"
},
"connectionLogOptionsCloudwatchLogGroup": {
"description": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log group.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ConnectionLogOptions.CloudwatchLogGroup"
},
"connectionLogOptionsCloudwatchLogStream": {
"description": "Describes the client connection logging options for the Client VPN endpoint.\nThe name of the CloudWatch Logs log stream to which the connection data is published.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ConnectionLogOptions.CloudwatchLogStream"
},
"dnsServersCustomDnsServers": {
"description": "Information about the DNS server to be used.\nThe IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that t...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "DnsServers.CustomDnsServers"
},
"dnsServersEnabled": {
"description": "Information about the DNS server to be used.\nIndicates whether DNS servers should be used. Specify False to delete the existing DNS servers.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "DnsServers.Enabled"
},
"description": {
"description": "A brief description of the Client VPN endpoint.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Description"
},
"vpcId": {
"description": "The ID of the VPC.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "VpcId"
},
"maxResults": {
"description": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "MaxResults"
},
"nextToken": {
"description": "The token to retrieve the next page of results.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "NextToken"
},
"associationIds": {
"description": "The IDs of the target network associations.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AssociationIds"
},
"destinationCidrBlock": {
"description": "The CIDR block associated with the local subnet of the customer network.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "DestinationCidrBlock"
},
"availabilityZone": {
"description": "The Availability Zone for the virtual private gateway.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AvailabilityZone"
},
"type": {
"description": "The type of VPN connection this virtual private gateway supports.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Type"
},
"amazonSideAsn": {
"description": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AmazonSideAsn"
},
"targetVpcSubnetId": {
"description": "The ID of the target subnet used by the route.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "TargetVpcSubnetId"
},
"customerGatewayId": {
"description": "The ID of the customer gateway.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "CustomerGatewayId"
},
"optionsStaticRoutesOnly": {
"description": "Describes VPN connection options.\n Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BG...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Options.StaticRoutesOnly"
},
"optionsTunnelOptions": {
"description": "Describes VPN connection options.\nThe tunnel options for the VPN connection.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Options.TunnelOptions"
},
"clientCidrBlock": {
"description": "The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associate...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ClientCidrBlock"
},
"authentication": {
"description": "Information about the authentication method to be used to authenticate clients.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Authentication"
},
"dnsServers": {
"description": "Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of t...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "DnsServers"
},
"transportProtocol": {
"description": "The transport protocol to be used by the VPN session. Default value: udp",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "TransportProtocol"
},
"clientToken": {
"description": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "ClientToken"
},
"tagSpecification": {
"description": "The tags to apply to the Client VPN endpoint during creation.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "TagSpecification"
},
"subnetId": {
"description": "The ID of the subnet to associate with the Client VPN endpoint.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "SubnetId"
},
"authorizeAllGroups": {
"description": "Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AuthorizeAllGroups"
},
"associationId": {
"description": "The ID of the target network association.",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "AssociationId"
},
"filter": {
"description": "One or more filters. customer-gateway-configuration - The configuration information for the customer gateway. customer-gateway-id - The ID of a custome...(description truncated)",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "Filter"
},
"bodyFormData": {
"description": "",
"parse": false,
"encode": false,
"encrypt": {
"type": "AES",
"key": ""
},
"external_name": "body"
}
},
"definitions": {}
}