Amazon EC2 Ec2 Transit Gateway Connect Peer API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Transit Gateway Connect Peer…
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Transit Gateway Connect Peer
paths:
  /?Action=CreateTransitGatewayConnectPeer:
    post:
      operationId: CreateTransitGatewayConnectPeer
      summary: Create Transit Gateway Connect Peer
      description: Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). For more information, see Connect peers in the Amazon Web Services Transit Gateways Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateTransitGatewayConnectPeer
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest'
      tags:
      - Transit Gateway Connect Peer
  /?Action=DeleteTransitGatewayConnectPeer:
    post:
      operationId: DeleteTransitGatewayConnectPeer
      summary: Delete Transit Gateway Connect Peer
      description: Deletes the specified Connect peer.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteTransitGatewayConnectPeer
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteTransitGatewayConnectPeerRequest'
      tags:
      - Transit Gateway Connect Peer
  /?Action=DescribeTransitGatewayConnectPeers:
    post:
      operationId: DescribeTransitGatewayConnectPeers
      summary: Describe Transit Gateway Connect Peers
      description: Describes one or more Connect peers.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeTransitGatewayConnectPeers
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeTransitGatewayConnectPeersRequest'
      tags:
      - Transit Gateway Connect Peer
components:
  schemas:
    TransitGatewayConnectPeer:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the Connect attachment.
        TransitGatewayConnectPeerId:
          type: string
          description: The ID of the Connect peer.
        State:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          description: The state of the Connect peer.
        CreationTime:
          type: string
          format: date-time
          description: The creation time.
        ConnectPeerConfiguration:
          $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the Connect peer.
    DeleteTransitGatewayConnectPeerRequest:
      type: object
      properties:
        TransitGatewayConnectPeerId:
          type: string
          description: The ID of the Connect peer.
        DryRun:
          type: boolean
          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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayConnectPeerId
    DescribeTransitGatewayConnectPeersRequest:
      type: object
      properties:
        TransitGatewayConnectPeerIds:
          type: array
          items:
            type: string
          description: The IDs of the Connect peers.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. The possible values are: state - The state of the Connect peer (pending | available | deleting | deleted). transit-gateway-attachment-id - The ID of the attachment. transit-gateway-connect-peer-id - The ID of the Connect peer.'
        MaxResults:
          type: integer
          description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
        NextToken:
          type: string
          description: The token for the next page of results.
        DryRun:
          type: boolean
          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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    CreateTransitGatewayConnectPeerRequest:
      type: object
      properties:
        TransitGatewayAttachmentId:
          type: string
          description: The ID of the Connect attachment.
        TransitGatewayAddress:
          type: string
          description: The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
        PeerAddress:
          type: string
          description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
        BgpOptions:
          $ref: '#/components/schemas/TransitGatewayConnectRequestBgpOptions'
        InsideCidrBlocks:
          type: array
          items:
            type: string
          description: The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the Connect peer.
        DryRun:
          type: boolean
          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, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - TransitGatewayAttachmentId
      - PeerAddress
      - InsideCidrBlocks
    TransitGatewayAttachmentBgpConfiguration:
      type: object
      properties:
        TransitGatewayAsn:
          type: integer
          description: The transit gateway Autonomous System Number (ASN).
        PeerAsn:
          type: integer
          description: The peer Autonomous System Number (ASN).
        TransitGatewayAddress:
          type: string
          description: The interior BGP peer IP address for the transit gateway.
        PeerAddress:
          type: string
          description: The interior BGP peer IP address for the appliance.
        BgpStatus:
          type: string
          enum:
          - up
          - down
          description: The BGP status.
    DescribeTransitGatewayConnectPeersResult:
      type: object
      properties:
        TransitGatewayConnectPeers:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayConnectPeer'
          description: Information about the Connect peers.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    TransitGatewayConnectPeerConfiguration:
      type: object
      properties:
        TransitGatewayAddress:
          type: string
          description: The Connect peer IP address on the transit gateway side of the tunnel.
        PeerAddress:
          type: string
          description: The Connect peer IP address on the appliance side of the tunnel.
        InsideCidrBlocks:
          type: array
          items:
            type: string
          description: The range of interior BGP peer IP addresses.
        Protocol:
          type: string
          enum:
          - gre
          description: The tunnel protocol.
        BgpConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration'
          description: The BGP configuration details.
    TransitGatewayConnectRequestBgpOptions:
      type: object
      properties:
        PeerAsn:
          type: integer
          description: The peer Autonomous System Number (ASN).
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    CreateTransitGatewayConnectPeerResult:
      type: object
      properties:
        TransitGatewayConnectPeer:
          $ref: '#/components/schemas/TransitGatewayConnectPeer'
    DeleteTransitGatewayConnectPeerResult:
      type: object
      properties:
        TransitGatewayConnectPeer:
          $ref: '#/components/schemas/TransitGatewayConnectPeer'
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)