Actions, resources, and condition keys for Amazon VPC Lattice
Amazon VPC Lattice (service prefix: vpc-lattice) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
Topics
Actions defined by Amazon VPC Lattice
You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| AssociateViaAWSService-EventsAndStates [permission only] | Grants permission to associate a resource configuration through Amazon EventBridge and AWS Step Functions service networks | Permissions management | |||
| CreateAccessLogSubscription | Grants permission to create an access log subscription | Write |
logs:CreateLogDelivery logs:GetLogDelivery |
||
| CreateListener | Grants permission to create a listener | Write | |||
| CreateResourceConfiguration | Grants permission to create a resource configuration | Write | |||
| CreateResourceGateway | Grants permission to create a resource gateway | Write |
ec2:DescribeSecurityGroups ec2:DescribeSubnets ec2:DescribeVpcs |
||
| CreateRule | Grants permission to create a rule | Write | |||
| CreateService | Grants permission to create a service | Write |
iam:CreateServiceLinkedRole |
||
| CreateServiceNetwork | Grants permission to create a service network | Write |
iam:CreateServiceLinkedRole |
||
| CreateServiceNetworkResourceAssociation | Grants permission to create an association between a service network and a resource | Write | |||
| CreateServiceNetworkServiceAssociation | Grants permission to create a service network and service association | Write | |||
| CreateServiceNetworkVpcAssociation | Grants permission to create a service network and VPC association | Write |
ec2:DescribeVpcs |
||
| CreateServiceNetworkVpcEndpointAssociation [permission only] | Grants permission to create an association between a service network and VPC endpoint | Permissions management | |||
| CreateTargetGroup | Grants permission to create a target group | Write |
iam:CreateServiceLinkedRole |
||
| DeleteAccessLogSubscription | Grants permission to delete an access log subscription | Write |
logs:DeleteLogDelivery logs:GetLogDelivery |
||
| DeleteAuthPolicy | Grants permission to delete an auth policy | Permissions management | |||
| DeleteListener | Grants permission to delete a listener | Write | |||
| DeleteResourceConfiguration | Grants permission to delete a resource configuration | Write | |||
| DeleteResourceEndpointAssociation | Grants permission to delete a resource endpoint association | Write | |||
| DeleteResourceGateway | Grants permission to delete a resource gateway | Write | |||
| DeleteResourcePolicy | Grants permission to delete a resource policy | Write | |||
| DeleteRule | Grants permission to delete a rule | Write | |||
| DeleteService | Grants permission to delete a service | Write | |||
| DeleteServiceNetwork | Grants permission to delete a service network | Write | |||
| DeleteServiceNetworkResourceAssociation | Grants permission to delete the association between a service network and resource | Write | |||
| DeleteServiceNetworkServiceAssociation | Grants permission to delete a service network service association | Write | |||
| DeleteServiceNetworkVpcAssociation | Grants permission to delete a service network and VPC association | Write | |||
| DeleteTargetGroup | Grants permission to delete a target group | Write | |||
| DeregisterTargets | Grants permission to deregister targets from a target group | Write | |||
| GetAccessLogSubscription | Grants permission to get information about an access log subscription | Read |
logs:GetLogDelivery |
||
| GetAuthPolicy | Grants permission to get information about an auth policy | Read | |||
| GetListener | Grants permission to get information about a listener | Read | |||
| GetResourceConfiguration | Grants permission to get information about a resource configuration | Read | |||
| GetResourceGateway | Grants permission to get information about a resource gateway | Read | |||
| GetResourcePolicy | Grants permission to get information about a resource policy | Read | |||
| GetRule | Grants permission to get information about a rule | Read | |||
| GetService | Grants permission to get information about a service | Read | |||
| GetServiceNetwork | Grants permission to get information about a service network | Read | |||
| GetServiceNetworkResourceAssociation | Grants permission to get information about an association between a service network and resource configuration | Read | |||
| GetServiceNetworkServiceAssociation | Grants permission to get information about a service network and service association | Read | |||
| GetServiceNetworkVpcAssociation | Grants permission to get information about a service network and VPC association | Read | |||
| GetTargetGroup | Grants permission to get information about a target group | Read | |||
| ListAccessLogSubscriptions | Grants permission to list some or all access log subscriptions about a service network or a service | List | |||
| ListListeners | Grants permission to list some or all listeners | List | |||
| ListResourceConfigurations | Grants permission to list some or all resource configurations | List | |||
| ListResourceEndpointAssociations | Grants permission to list some or all associations between a resource configuration and VPC endpoint | List | |||
| ListResourceGateways | Grants permission to list some or all resource gateways | List | |||
| ListRules | Grants permission to list some or all rules | List | |||
| ListServiceNetworkResourceAssociations | Grants permission to list some or all associations between a service network and resource configuration | List | |||
| ListServiceNetworkServiceAssociations | Grants permission to list some or all service network and service associations | List | |||
| ListServiceNetworkVpcAssociations | Grants permission to list some or all service network and VPC associations | List | |||
| ListServiceNetworkVpcEndpointAssociations | Grants permission to list some or all associations between a service network and VPC endpoint | List | |||
| ListServiceNetworks | Grants permission to list the service networks owned by a caller account or shared with the caller account | List | |||
| ListServices | Grants permission to list the services owned by a caller account or shared with the caller account | List | |||
| ListTagsForResource | Grants permission to list tags for a vpc-lattice resource | Read | |||
| ListTargetGroups | Grants permission to list some or all target groups | List | |||
| ListTargets | Grants permission to list some or all targets in a target group | List | |||
| PutAuthPolicy | Grants permission to create or update the auth policy for a service network or a service | Permissions management | |||
| PutResourcePolicy | Grants permission to create a resource policy for a resource configuration, service, or service network | Write | |||
| RegisterTargets | Grants permission to register targets to a target group | Write | |||
| TagResource | Grants permission to tag a vpc-lattice resource | Tagging | |||
| UntagResource | Grants permission to untag a vpc-lattice resource | Tagging | |||
| UpdateAccessLogSubscription | Grants permission to update an access log subscription | Write |
logs:GetLogDelivery logs:UpdateLogDelivery |
||
| UpdateListener | Grants permission to update a listener | Write | |||
| UpdateResourceConfiguration | Grants permission to update a resource configuration | Write | |||
| UpdateResourceGateway | Grants permission to update a resource gateway | Write | |||
| UpdateRule | Grants permission to update a rule | Write | |||
| UpdateService | Grants permission to update a service | Write | |||
| UpdateServiceNetwork | Grants permission to update a service network | Write | |||
| UpdateServiceNetworkVpcAssociation | Grants permission to update a service network and VPC association | Write |
ec2:DescribeSecurityGroups ec2:DescribeVpcs |
||
| UpdateTargetGroup | Grants permission to update a target group | Write | |||
Resource types defined by Amazon VPC Lattice
The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| AccessLogSubscription |
arn:${Partition}:vpc-lattice:${Region}:${Account}:accesslogsubscription/${AccessLogSubscriptionId}
|
|
| Listener |
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId}/listener/${ListenerId}
|
|
| ResourceConfiguration |
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourceconfiguration/${ResourceConfigurationId}
|
|
| ResourceEndpointAssociation |
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourceendpointassociation/${ResourceEndpointAssociationId}
|
|
| ResourceGateway |
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourcegateway/${ResourceGatewayId}
|
|
| Rule |
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId}/listener/${ListenerId}/rule/${RuleId}
|
|
| Service |
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId}
|
|
| ServiceNetwork |
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetwork/${ServiceNetworkId}
|
|
| ServiceNetworkResourceAssociation |
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkresourceassociation/${ServiceNetworkResourceAssociationId}
|
|
| ServiceNetworkServiceAssociation |
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkserviceassociation/${ServiceNetworkServiceAssociationId}
|
|
| ServiceNetworkVpcAssociation |
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkvpcassociation/${ServiceNetworkVpcAssociationId}
|
|
| TargetGroup |
arn:${Partition}:vpc-lattice:${Region}:${Account}:targetgroup/${TargetGroupId}
|
Condition keys for Amazon VPC Lattice
Amazon VPC Lattice defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
| Condition keys | Description | Type |
|---|---|---|
| aws:RequestTag/${TagKey} | Filters access by the presence of tag key-value pairs in the request | String |
| aws:ResourceTag/${TagKey} | Filters access by tag key-value pairs attached to the resource | String |
| aws:TagKeys | Filters access by the presence of tag keys in the request | ArrayOfString |
| vpc-lattice:AuthType | Filters access by the auth type specified in the request | String |
| vpc-lattice:Protocol | Filters access by the protocol specified in the request | String |
| vpc-lattice:ResourceConfigurationArn | Filters access by the ARN of a resource configuration | ARN |
| vpc-lattice:SecurityGroupIds | Filters access by the IDs of security groups | ArrayOfString |
| vpc-lattice:ServiceArn | Filters access by the ARN of a service | ARN |
| vpc-lattice:ServiceNetworkArn | Filters access by the ARN of a service network | ARN |
| vpc-lattice:TargetGroupArns | Filters access by the ARNs of target groups | ArrayOfARN |
| vpc-lattice:VpcEndpointId | Filters access by the ID of a VPC endpoint | String |
| vpc-lattice:VpcId | Filters access by the ID of a virtual private cloud (VPC) | String |
