attach_vpn_gateway¶
Operation¶
attach_vpn_gateway
¶
attach_vpn_gateway(request: AttachVpnGatewayInput | AttachVpnGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AttachVpnGatewayInputDict]) -> AttachVpnGatewayOutput
Attaches an available virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
AttachVpnGatewayInput | AttachVpnGatewayInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[AttachVpnGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
AttachVpnGatewayOutput
|
An instance of |
attach_vpn_gateway
async
¶
attach_vpn_gateway(request: AttachVpnGatewayInput | AttachVpnGatewayInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[AttachVpnGatewayInputDict]) -> AttachVpnGatewayOutput
Attaches an available virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
AttachVpnGatewayInput | AttachVpnGatewayInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[AttachVpnGatewayInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
AttachVpnGatewayOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
AttachVpnGatewayInputDict
¶
Bases: TypedDict
Dictionary form of AttachVpnGatewayInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | 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.
AttachVpnGatewayInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for AttachVpnGateway.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | 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.
Output¶
AttachVpnGatewayOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of AttachVpnGateway.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
vpc_attachment
class-attribute
instance-attribute
¶
vpc_attachment: VpcAttachment | None = ...
Information about the attachment.