Skip to content

create_vpn_concentrator

create_vpn_concentrator(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    type: Optional[VpnConcentratorType] = None,
    transit_gateway_id: Optional[TransitGatewayId] = None,
    tag_specifications: Optional[TagSpecificationList] = None,
    dry_run: Optional[Boolean] = None,
) -> CreateVpnConcentratorResult

Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.

Parameters:

  • type (Optional[VpnConcentratorType], default: None ) –

    The type of VPN concentrator to create.

  • transit_gateway_id (Optional[TransitGatewayId], default: None ) –

    The ID of the transit gateway to attach the VPN concentrator to.

  • tag_specifications (Optional[TagSpecificationList], default: None ) –

    The tags to apply to the VPN concentrator during creation.

  • dry_run (Optional[Boolean], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def create_vpn_concentrator(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    type: Optional[
        "capo_ec2.types.vpn_concentrator_type.VpnConcentratorType"
    ] = None,
    transit_gateway_id: Optional[
        "capo_ec2.types.transit_gateway_id.TransitGatewayId"
    ] = None,
    tag_specifications: Optional[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.create_vpn_concentrator_result.CreateVpnConcentratorResult":
    """<p>Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.</p>

    Args:
        type: <p>The type of VPN concentrator to create.</p>
        transit_gateway_id: <p>The ID of the transit gateway to attach the VPN concentrator to.</p>
        tag_specifications: <p>The tags to apply to the VPN concentrator during creation.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.create_vpn_concentrator_request.CreateVpnConcentratorRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.create_vpn_concentrator_result.CreateVpnConcentratorResult"
    ]:
        import capo_ec2._operations.amazon_ec2.create_vpn_concentrator

        output, http_response = (
            capo_ec2._operations.amazon_ec2.create_vpn_concentrator.create_vpn_concentrator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateVpnConcentrator")
    )
    input_: capo_ec2.types.create_vpn_concentrator_request.CreateVpnConcentratorRequest = {}
    if type is not None:
        input_["type"] = type
    if transit_gateway_id is not None:
        input_["transit_gateway_id"] = transit_gateway_id
    if tag_specifications is not None:
        input_["tag_specifications"] = tag_specifications
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output