Skip to content

apply_security_groups_to_client_vpn_target_network

Operation

apply_security_groups_to_client_vpn_target_network

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

Parameters:

Name Type Description Default
request ApplySecurityGroupsToClientVpnTargetNetworkInput | ApplySecurityGroupsToClientVpnTargetNetworkInputDict | 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[ApplySecurityGroupsToClientVpnTargetNetworkInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ApplySecurityGroupsToClientVpnTargetNetworkOutput

An instance of ApplySecurityGroupsToClientVpnTargetNetworkOutput.

apply_security_groups_to_client_vpn_target_network async

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

Parameters:

Name Type Description Default
request ApplySecurityGroupsToClientVpnTargetNetworkInput | ApplySecurityGroupsToClientVpnTargetNetworkInputDict | 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[ApplySecurityGroupsToClientVpnTargetNetworkInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ApplySecurityGroupsToClientVpnTargetNetworkOutput

An instance of ApplySecurityGroupsToClientVpnTargetNetworkOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ApplySecurityGroupsToClientVpnTargetNetworkInputDict

Bases: TypedDict

Dictionary form of ApplySecurityGroupsToClientVpnTargetNetworkInput.

Attributes

client_vpn_endpoint_id instance-attribute
client_vpn_endpoint_id: Required[str]

The ID of the Client VPN endpoint.

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.

security_group_ids instance-attribute
security_group_ids: Required[Sequence[str]]

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

vpc_id instance-attribute
vpc_id: Required[str]

The ID of the VPC in which the associated target network is located.

ApplySecurityGroupsToClientVpnTargetNetworkInput dataclass

Bases: _SerdeShape

Dataclass for ApplySecurityGroupsToClientVpnTargetNetworkInput structure.

Attributes

client_vpn_endpoint_id class-attribute instance-attribute
client_vpn_endpoint_id: str | None = ...

The ID of the Client VPN endpoint.

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.

security_group_ids class-attribute instance-attribute
security_group_ids: list[str] | None = ...

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

vpc_id class-attribute instance-attribute
vpc_id: str | None = ...

The ID of the VPC in which the associated target network is located.

Output

ApplySecurityGroupsToClientVpnTargetNetworkOutput dataclass

Bases: _SerdeShape

Dataclass for ApplySecurityGroupsToClientVpnTargetNetworkOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

security_group_ids class-attribute instance-attribute
security_group_ids: list[str] | None = ...

The IDs of the applied security groups.