Actions, resources, and condition keys for Amazon VPC Lattice
Amazon VPC Lattice (service prefix: vpc-lattice) provides the following
service-specific operations, resources, actions, and condition 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.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon VPC Lattice
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
BatchUpdateRule |
Write |
|||
|
CreateAccessLogSubscription |
Write |
|||
Tagging, Write |
||||
|
CreateListener |
Write |
|||
Tagging, Write |
||||
|
CreateResourceConfiguration |
Write |
|||
Tagging, Write |
||||
|
CreateResourceGateway |
Write |
|||
Tagging, Write |
||||
|
CreateRule |
Write |
|||
Tagging, Write |
||||
|
CreateService |
Write |
|||
Tagging, Write |
||||
|
CreateServiceNetwork |
Write |
|||
Tagging, Write |
||||
|
CreateServiceNetworkResourceAssociation |
Permissions management, Write |
|||
Permissions management, Write |
||||
Write |
||||
Tagging, Write |
||||
|
CreateServiceNetworkServiceAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateServiceNetworkVpcAssociation |
Write |
|||
Tagging, Write |
||||
|
CreateTargetGroup |
Write |
|||
Tagging, Write |
||||
|
DeleteAccessLogSubscription |
Write |
|||
|
DeleteAuthPolicy |
Permissions management, Write |
|||
|
DeleteDomainVerification |
Write |
|||
|
DeleteListener |
Write |
|||
|
DeleteResourceConfiguration |
Write |
|||
|
DeleteResourceEndpointAssociation |
Write |
|||
|
DeleteResourceGateway |
Write |
|||
|
DeleteResourcePolicy |
Write |
|||
|
DeleteRule |
Write |
|||
|
DeleteService |
Write |
|||
|
DeleteServiceNetwork |
Write |
|||
|
DeleteServiceNetworkResourceAssociation |
Write |
|||
|
DeleteServiceNetworkServiceAssociation |
Write |
|||
|
DeleteServiceNetworkVpcAssociation |
Write |
|||
|
DeleteTargetGroup |
Write |
|||
|
DeregisterTargets |
Write |
|||
|
GetAccessLogSubscription |
Read |
|||
|
GetAuthPolicy |
Read |
|||
|
GetDomainVerification |
Read |
|||
|
GetListener |
Read |
|||
|
GetResourceConfiguration |
Read |
|||
|
GetResourceGateway |
Read |
|||
|
GetResourcePolicy |
Read |
|||
|
GetRule |
Read |
|||
|
GetService |
Read |
|||
|
GetServiceNetwork |
Read |
|||
|
GetServiceNetworkResourceAssociation |
Read |
|||
|
GetServiceNetworkServiceAssociation |
Read |
|||
|
GetServiceNetworkVpcAssociation |
Read |
|||
|
GetTargetGroup |
Read |
|||
|
ListAccessLogSubscriptions |
List |
|||
|
ListDomainVerifications |
List |
|||
|
ListListeners |
List |
|||
|
ListResourceConfigurations |
List |
|||
|
ListResourceEndpointAssociations |
List |
|||
|
ListResourceGateways |
List |
|||
|
ListRules |
List |
|||
|
ListServiceNetworkResourceAssociations |
List |
|||
|
ListServiceNetworkServiceAssociations |
List |
|||
|
ListServiceNetworkVpcAssociations |
List |
|||
|
ListServiceNetworkVpcEndpointAssociations |
List |
|||
|
ListServiceNetworks |
List |
|||
|
ListServices |
List |
|||
|
ListTagsForResource |
Read |
|||
|
ListTargetGroups |
List |
|||
|
ListTargets |
List |
|||
|
PutAuthPolicy |
Permissions management, Write |
|||
|
PutResourcePolicy |
Write |
|||
|
RegisterTargets |
Write |
|||
|
StartDomainVerification |
Write |
|||
Tagging, Write |
||||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateAccessLogSubscription |
Write |
|||
|
UpdateListener |
Write |
|||
|
UpdateResourceConfiguration |
Write |
|||
|
UpdateResourceGateway |
Write |
|||
|
UpdateRule |
Write |
|||
|
UpdateService |
Write |
|||
|
UpdateServiceNetwork |
Write |
|||
|
UpdateServiceNetworkVpcAssociation |
Write |
|||
|
UpdateTargetGroup |
Write |
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.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create an access log subscription |
Write |
|||
Grants permission to create a listener |
Write |
|||
Grants permission to create a resource configuration |
Write |
|||
Grants permission to create a resource gateway |
Write |
|||
Grants permission to create a rule |
Write |
|||
Grants permission to create a service |
Write |
|||
Grants permission to create a service network |
Write |
|||
Grants permission to create an association between a service network and a resource |
Write |
|||
Grants permission to create a service network and service association |
Write |
|||
Grants permission to create a service network and VPC association |
vpc-lattice:PrivateDnsPreference |
Write |
||
|
vpc-lattice:PrivateDnsPreference |
||||
Grants permission to create a target group |
Write |
|||
Grants permission to delete an access log subscription |
Write |
|||
Grants permission to delete an auth policy |
Permissions management, Write |
|||
Grants permission to delete a domain verification |
Write |
|||
Grants permission to delete a listener |
Write |
|||
Grants permission to delete a resource configuration |
Write |
|||
Grants permission to delete a resource endpoint association |
Write |
|||
Grants permission to delete a resource gateway |
Write |
|||
Grants permission to delete a resource policy |
Write |
|||
Grants permission to delete a rule |
Write |
|||
Grants permission to delete a service |
Write |
|||
Grants permission to delete a service network |
Write |
|||
Grants permission to delete the association between a service network and resource |
Write |
|||
Grants permission to delete a service network service association |
Write |
|||
Grants permission to delete a service network and VPC association |
vpc-lattice:PrivateDnsPreference |
Write |
||
Grants permission to delete a target group |
Write |
|||
Grants permission to deregister targets from a target group |
Write |
|||
Grants permission to get information about an access log subscription |
Read |
|||
Grants permission to get information about an auth policy |
Read |
|||
Grants permission to get information about a domain verification |
Read |
|||
Grants permission to get information about a listener |
Read |
|||
Grants permission to get information about a resource configuration |
Read |
|||
Grants permission to get information about a resource gateway |
Read |
|||
Grants permission to get information about a resource policy |
Read |
|||
Grants permission to get information about a rule |
Read |
|||
Grants permission to get information about a service |
Read |
|||
Grants permission to get information about a service network |
Read |
|||
Grants permission to get information about an association between a service network and resource configuration |
Read |
|||
Grants permission to get information about a service network and service association |
Read |
|||
Grants permission to get information about a service network and VPC association |
vpc-lattice:PrivateDnsPreference |
Read |
||
Grants permission to get information about a target group |
Read |
|||
Grants permission to list some or all access log subscriptions about a service network or a service |
List |
|||
Grants permission to list some or all domain verifications |
List |
|||
Grants permission to list some or all listeners |
List |
|||
Grants permission to list some or all resource configurations |
List |
|||
Grants permission to list some or all associations between a resource configuration and VPC endpoint |
List |
|||
Grants permission to list some or all resource gateways |
List |
|||
Grants permission to list some or all rules |
List |
|||
Grants permission to list some or all associations between a service network and resource configuration |
List |
|||
Grants permission to list some or all service network and service associations |
List |
|||
Grants permission to list some or all service network and VPC associations |
List |
|||
Grants permission to list some or all associations between a service network and VPC endpoint |
List |
|||
Grants permission to list the service networks owned by a caller account or shared with the caller account |
List |
|||
Grants permission to list the services owned by a caller account or shared with the caller account |
List |
|||
Grants permission to list tags for a vpc-lattice resource |
Read |
|||
Grants permission to list some or all target groups |
List |
|||
Grants permission to list some or all targets in a target group |
List |
|||
Grants permission to create or update the auth policy for a service network or a service |
Permissions management, Write |
|||
Grants permission to create a resource policy for a resource configuration, service, or service network |
Write |
|||
Grants permission to register targets to a target group |
Write |
|||
Grants permission to start a domain verification |
Write |
|||
Grants permission to tag a vpc-lattice resource |
Tagging, Write |
|||
|
vpc-lattice:PrivateDnsPreference |
||||
Grants permission to untag a vpc-lattice resource |
Tagging, Write |
|||
|
vpc-lattice:PrivateDnsPreference |
||||
Grants permission to update an access log subscription |
Write |
|||
Grants permission to update a listener |
Write |
|||
Grants permission to update a resource configuration |
Write |
|||
Grants permission to update a resource gateway |
Write |
|||
Grants permission to update a rule |
Write |
|||
Grants permission to update a service |
Write |
|||
Grants permission to update a service network |
Write |
|||
Grants permission to update a service network and VPC association |
vpc-lattice:PrivateDnsPreference |
Write |
||
Grants permission to update a target group |
Write |
Permission-only actions for Amazon VPC Lattice
The following actions are defined by Amazon VPC Lattice but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate a resource configuration through any AWS service managed networks |
Permissions management, Write |
|||
Grants permission to associate a resource configuration through Amazon EventBridge and AWS Step Functions service networks |
Permissions management, Write |
|||
Grants permission to create an association between a service network and VPC endpoint |
Permissions management, 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.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:vpc-lattice:${Region}:${Account}:accesslogsubscription/${AccessLogSubscriptionId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:domainverification/${DomainVerificationId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId}/listener/${ListenerId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourceconfiguration/${ResourceConfigurationId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourceendpointassociation/${ResourceEndpointAssociationId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:resourcegateway/${ResourceGatewayId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId}/listener/${ListenerId}/rule/${RuleId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:service/${ServiceId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetwork/${ServiceNetworkId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkresourceassociation/${ServiceNetworkResourceAssociationId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkserviceassociation/${ServiceNetworkServiceAssociationId} |
||
arn:${Partition}:vpc-lattice:${Region}:${Account}:servicenetworkvpcassociation/${ServiceNetworkVpcAssociationId} |
vpc-lattice:PrivateDnsPreference |
|
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.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the presence of tag key-value pairs in the request |
String |
|
Filters access by tag key-value pairs attached to the resource |
String |
|
Filters access by the presence of tag keys in the request |
ArrayOfString |
|
Filters access by the auth type specified in the request |
String |
|
Filters access by the name of a resource-creating API action |
String |
|
Filters access by the domain name |
String |
|
Filters access by the private dns preference |
String |
|
Filters access by the private dns domains |
ArrayOfString |
|
Filters access by the protocol specified in the request |
String |
|
Filters access by the ARN of a resource configuration |
ARN |
|
Filters access by the IDs of security groups |
ArrayOfString |
|
Filters access by the ARN of a service |
ARN |
|
Filters access by the ARN of a service network |
ARN |
|
Filters access by the ARNs of target groups |
ArrayOfARN |
|
Filters access by the ID of a VPC endpoint |
String |
|
Filters access by the ID of a virtual private cloud (VPC) |
String |
