vpc_endpoint_service_configuration#

States module for managing EC2 VPC Endpoint Service Configurations.

async idem_aws.states.aws.ec2.vpc_endpoint_service_configuration.present(hub, ctx, name: str, resource_id: 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, str] = 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]

Example

my-vpc-endpoint-service-configuration:
  aws.ec2.vpc_endpoint_service_configuration.present:
    - acceptance_required: bool
    - private_dns_name: string
    - network_load_balancer_arns:
      - value
    - gateway_load_balancer_arns:
      - value
    - supported_ip_address_types:
      - value
    - client_token: string
    - tags:
        - Key: string
          Value: string
async idem_aws.states.aws.ec2.vpc_endpoint_service_configuration.absent(hub, ctx, name: str, resource_id: 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:

  • name (str) – Idem name of the resource.

  • resource_id (str, Optional) – The ID of the service. Defaults to None.

Returns:

Dict[str, Any]

Example

my-vpc-endpoint-service-configuration:
    aws.ec2.vpc_endpoint_service_configuration.absent:
      - name: my-vpc-endpoint-service-configuration
      - resource_id: value
async idem_aws.states.aws.ec2.vpc_endpoint_service_configuration.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

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

Returns:

Dict[str, Any]

Example

$ idem describe aws.ec2.vpc_endpoint_service_configuration