vpc_endpoint_service_configuration#

Exec module for managing EC2 VPC Endpoint Service Configurations.

async idem_aws.exec.aws.ec2.vpc_endpoint_service_configuration.get(hub, ctx, resource_id: str, filters: List[Filter] = None, name: str = None) → Dict[str, Any][source]#

Describes the VPC endpoint service configurations in your account (your services).

Parameters:

  • resource_id (str) – The ID of the service.

  • filters (List[dict[str, Any]], Optional) –

    The filters.

    • service-name - The name of the service.

    • service-id - The ID of the service.

    • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

    • supported-ip-address-types - The IP address type (ipv4 | ipv6).

    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Defaults to None.

    Filter names and 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.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resource:
  exec.run:
    - path: aws.ec2.vpc_endpoint_service_configuration.get
    - kwargs:
        resource_id: value

Exec call from the CLI:

idem exec aws.ec2.vpc_endpoint_service_configuration.get resource_id=service-id
async idem_aws.exec.aws.ec2.vpc_endpoint_service_configuration.list_(hub, ctx, service_ids: List[str] = None, filters: List[Filter] = None) → Dict[str, Any][source]#

Describes the VPC endpoint service configurations in your account (your services).

Parameters:

  • service_ids (List[str], Optional) – The IDs of the endpoint services. Defaults to None.

  • filters (List[dict[str, Any]], Optional) –

    The filters.

    • service-name - The name of the service.

    • service-id - The ID of the service.

    • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

    • supported-ip-address-types - The IP address type (ipv4 | ipv6).

    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Defaults to None.

    Filter names and 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.

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resources:
  exec.run:
    - path: aws.ec2.vpc_endpoint_service_configuration.list
    - kwargs:

Exec call from the CLI:

idem exec aws.ec2.vpc_endpoint_service_configuration.list
async idem_aws.exec.aws.ec2.vpc_endpoint_service_configuration.create(hub, ctx, name: str = None, acceptance_required: bool = None, private_dns_name: str = None, network_load_balancer_arns: List[str] = None, gateway_load_balancer_arns: List[str] = None, supported_ip_address_types: List[str] = None, client_token: str = None, tags: Dict[str, Any] = None) → Dict[str, Any][source]#

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts, users, and IAM roles) can connect.

Before you create an endpoint service, you must create one of the following for your service:

  • A Network Load Balancer. Service consumers connect to your service using an interface endpoint.

  • A Gateway Load Balancer. Service consumers connect to your service using a Gateway Load Balancer endpoint.

If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see the Amazon Web Services PrivateLink Guide.

Parameters:

  • name (str, Optional) – Idem name of the resource. Defaults to None.

  • acceptance_required (bool, Optional) – Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually. Defaults to None.

  • private_dns_name (str, Optional) – (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service. Defaults to None.

  • network_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of the Network Load Balancers. Defaults to None.

  • gateway_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of the Gateway Load Balancers. Defaults to None.

  • supported_ip_address_types (List[str], Optional) – The supported IP address types. The possible values are ipv4 and ipv6. Defaults to None.

  • client_token (str, Optional) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency. Defaults to None.

  • tags (Dict or List, Optional) –

    Dict in the format of {tag-key: tag-value} or List of tags in the format of [{“Key”: tag-key, “Value”: tag-value}] to associate with the VPC. Each tag consists of a key name and an associated value. Defaults to None.

    • Key (str, Optional): 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(str, Optional): The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Returns:

Dict[str, Any]

Examples

Using in a state:

unmanaged_resources:
  exec.run:
    - path: aws.ec2.vpc_endpoint_service_configuration.create
    - kwargs:

Exec call from the CLI:

idem exec aws.ec2.vpc_endpoint_service_configuration.create
async idem_aws.exec.aws.ec2.vpc_endpoint_service_configuration.update(hub, ctx, resource_id: str, name: str = None, private_dns_name: str = None, remove_private_dns_name: bool = None, acceptance_required: bool = None, add_network_load_balancer_arns: List[str] = None, remove_network_load_balancer_arns: List[str] = None, add_gateway_load_balancer_arns: List[str] = None, remove_gateway_load_balancer_arns: List[str] = None, add_supported_ip_address_types: List[str] = None, remove_supported_ip_address_types: List[str] = None, tags: Dict[str, Any] = None) → Dict[str, Any][source]#

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

If you set or modify the private DNS name, you must prove that you own the private DNS domain name.

Parameters:

  • resource_id (str) – The ID of the service.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

  • private_dns_name (str, Optional) – (Interface endpoint configuration) The private DNS name to assign to the endpoint service. Defaults to None.

  • remove_private_dns_name (bool, Optional) – (Interface endpoint configuration) Removes the private DNS name of the endpoint service. Defaults to None.

  • acceptance_required (bool, Optional) – Indicates whether requests to create an endpoint to your service must be accepted. Defaults to None.

  • add_network_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration. Defaults to None.

  • remove_network_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration. Defaults to None.

  • add_gateway_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration. Defaults to None.

  • remove_gateway_load_balancer_arns (List[str], Optional) – The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration. Defaults to None.

  • add_supported_ip_address_types (List[str], Optional) – The IP address types to add to your service configuration. Defaults to None.

  • remove_supported_ip_address_types (List[str], Optional) – The IP address types to remove from your service configuration. Defaults to None.

  • tags (Dict or List, Optional) –

    Dict in the format of {tag-key: tag-value} or List of tags in the format of [{“Key”: tag-key, “Value”: tag-value}] to associate with the VPC. Each tag consists of a key name and an associated value. Defaults to None.

    • Key (str, Optional): 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(str, Optional): The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Returns:

Dict[str, Any]

Examples

Using in a state:

unmanaged_resources:
  exec.run:
    - path: aws.ec2.vpc_endpoint_service_configuration.update
    - kwargs:
        - resource_id: value

Exec call from the CLI:

idem exec aws.ec2.vpc_endpoint_service_configuration.update resource_id=value
async idem_aws.exec.aws.ec2.vpc_endpoint_service_configuration.delete(hub, ctx, resource_id: str, name: str = None) → Dict[str, Any][source]#

Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

Parameters:

  • resource_id (str) – The ID of the services.

  • name (str, Optional) – Idem name of the resource. Defaults to None.

Returns:

Dict[str, Any]

Examples

Resource State:

resource_is_absent:
  aws.ec2.vpc_endpoint_service_configuration.absent:
    - resource_id: value

Exec call from the CLI:

idem exec aws.ec2.vpc_endpoint_service_configuration.delete resource_id=value