vpc_endpoint_service_permission#

States module for managing EC2 VPC Endpoint Service Permissions.

async idem_aws.states.aws.ec2.vpc_endpoint_service_permission.present(hub, ctx, name: str, service_id: str, principal_arn: str, resource_id: str = None) → Dict[str, Any][source]#

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

Parameters:

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

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

  • principal_arn (str, Optional) – The Amazon Resource Name (ARN) of the principal. To grant permissions to all principals, specify an asterisk (*).

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

Returns:

Dict[str, Any]

Example

my-vpc-endpoint-service-permission:
  aws.ec2.vpc_endpoint_service_permission.present:
    - service_id: value
    - principal_arn: value
async idem_aws.states.aws.ec2.vpc_endpoint_service_permission.absent(hub, ctx, name: str, service_id: str, principal_arn: str, resource_id: str = None) → Dict[str, Any][source]#

Removes the permissions for your VPC endpoint service. You can remove permissions for service consumers (Amazon Web Services accounts, users, and IAM roles) to connect to your endpoint service.

Parameters:

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

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

  • principal_arn (str, Optional) – The Amazon Resource Name (ARN) of the principal.

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

Returns:

Dict[str, Any]

Example

my-vpc-endpoint-service-permission:
  aws.ec2.vpc_endpoint_service_permission.absent:
    - service_id: value
    - principal_arn: value
async idem_aws.states.aws.ec2.vpc_endpoint_service_permission.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

Returns:

Dict[str, Any]

Example

$ idem describe aws.ec2.vpc_endpoint_service_permission