Vpc Lattice

This page documents function available when using the Vpc_Lattice module, created with @service Vpc_Lattice.

Index

Documentation

Main.Vpc_Lattice.batch_update_ruleMethod
batch_update_rule(listener_identifier, rules, service_identifier)
batch_update_rule(listener_identifier, rules, service_identifier, params::Dict{String,<:Any})

Updates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • rules: The rules for the specified listener.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.create_access_log_subscriptionMethod
create_access_log_subscription(destination_arn, resource_identifier)
create_access_log_subscription(destination_arn, resource_identifier, params::Dict{String,<:Any})

Enables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner will only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.

Arguments

  • destination_arn: The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.
  • resource_identifier: The ID or Amazon Resource Name (ARN) of the service network or service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "tags": The tags for the access log subscription.
Main.Vpc_Lattice.create_listenerMethod
create_listener(default_action, name, protocol, service_identifier)
create_listener(default_action, name, protocol, service_identifier, params::Dict{String,<:Any})

Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.

Arguments

  • default_action: The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.
  • name: The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  • protocol: The listener protocol HTTP or HTTPS.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "port": The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.
  • "tags": The tags for the listener.
Main.Vpc_Lattice.create_ruleMethod
create_rule(action, listener_identifier, match, name, priority, service_identifier)
create_rule(action, listener_identifier, match, name, priority, service_identifier, params::Dict{String,<:Any})

Creates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Arguments

  • action: The action for the default rule.
  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • match: The rule match.
  • name: The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  • priority: The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "tags": The tags for the rule.
Main.Vpc_Lattice.create_serviceMethod
create_service(name)
create_service(name, params::Dict{String,<:Any})

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC). For more information, see Services in the Amazon VPC Lattice User Guide.

Arguments

  • name: The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authType": The type of IAM policy. NONE: The resource does not use an IAM policy. This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
  • "certificateArn": The Amazon Resource Name (ARN) of the certificate.
  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "customDomainName": The custom domain name of the service.
  • "tags": The tags for the service.
Main.Vpc_Lattice.create_service_networkMethod
create_service_network(name)
create_service_network(name, params::Dict{String,<:Any})

Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. For more information, see Service networks in the Amazon VPC Lattice User Guide.

Arguments

  • name: The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authType": The type of IAM policy. NONE: The resource does not use an IAM policy. This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "tags": The tags for the service network.
Main.Vpc_Lattice.create_service_network_service_associationMethod
create_service_network_service_association(service_identifier, service_network_identifier)
create_service_network_service_association(service_identifier, service_network_identifier, params::Dict{String,<:Any})

Associates a service with a service network. You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it. You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network. As a result of this operation, the association is created in the service network account and the association owner account.

Arguments

  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
  • service_network_identifier: The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "tags": The tags for the association.
Main.Vpc_Lattice.create_service_network_vpc_associationMethod
create_service_network_vpc_association(service_network_identifier, vpc_identifier)
create_service_network_vpc_association(service_network_identifier, vpc_identifier, params::Dict{String,<:Any})

Associates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide. You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it. As a result of this operation, the association gets created in the service network account and the VPC owner account. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Arguments

  • service_network_identifier: The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN when the resources specified in the operation are in different accounts.
  • vpc_identifier: The ID of the VPC.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "securityGroupIds": The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.
  • "tags": The tags for the association.
Main.Vpc_Lattice.create_target_groupMethod
create_target_group(name, type)
create_target_group(name, type, params::Dict{String,<:Any})

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see Target groups in the Amazon VPC Lattice User Guide.

Arguments

  • name: The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  • type: The type of target group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  • "config": The target group configuration. If type is set to LAMBDA, this parameter doesn't apply.
  • "tags": The tags for the target group.
Main.Vpc_Lattice.delete_access_log_subscriptionMethod
delete_access_log_subscription(access_log_subscription_identifier)
delete_access_log_subscription(access_log_subscription_identifier, params::Dict{String,<:Any})

Deletes the specified access log subscription.

Arguments

  • access_log_subscription_identifier: The ID or Amazon Resource Name (ARN) of the access log subscription.
Main.Vpc_Lattice.delete_auth_policyMethod
delete_auth_policy(resource_identifier)
delete_auth_policy(resource_identifier, params::Dict{String,<:Any})

Deletes the specified auth policy. If an auth is set to AWSIAM and the auth policy is deleted, all requests will be denied by default. If you are trying to remove the auth policy completely, you must set the authtype to NONE. If auth is enabled on the resource, but no auth policy is set, all requests will be denied.

Arguments

  • resource_identifier: The ID or Amazon Resource Name (ARN) of the resource.
Main.Vpc_Lattice.delete_listenerMethod
delete_listener(listener_identifier, service_identifier)
delete_listener(listener_identifier, service_identifier, params::Dict{String,<:Any})

Deletes the specified listener.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.delete_resource_policyMethod
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

Deletes the specified resource policy.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Vpc_Lattice.delete_ruleMethod
delete_rule(listener_identifier, rule_identifier, service_identifier)
delete_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})

Deletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • rule_identifier: The ID or Amazon Resource Name (ARN) of the rule.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.delete_serviceMethod
delete_service(service_identifier)
delete_service(service_identifier, params::Dict{String,<:Any})

Deletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.

Arguments

  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.delete_service_networkMethod
delete_service_network(service_network_identifier)
delete_service_network(service_network_identifier, params::Dict{String,<:Any})

Deletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.

Arguments

  • service_network_identifier: The Amazon Resource Name (ARN) or ID of the service network.
Main.Vpc_Lattice.delete_service_network_service_associationMethod
delete_service_network_service_association(service_network_service_association_identifier)
delete_service_network_service_association(service_network_service_association_identifier, params::Dict{String,<:Any})

Deletes the association between a specified service and the specific service network. This request will fail if an association is still in progress.

Arguments

  • service_network_service_association_identifier: The ID or Amazon Resource Name (ARN) of the association.
Main.Vpc_Lattice.delete_service_network_vpc_associationMethod
delete_service_network_vpc_association(service_network_vpc_association_identifier)
delete_service_network_vpc_association(service_network_vpc_association_identifier, params::Dict{String,<:Any})

Disassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.

Arguments

  • service_network_vpc_association_identifier: The ID or Amazon Resource Name (ARN) of the association.
Main.Vpc_Lattice.delete_target_groupMethod
delete_target_group(target_group_identifier)
delete_target_group(target_group_identifier, params::Dict{String,<:Any})

Deletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.

Arguments

  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.
Main.Vpc_Lattice.deregister_targetsMethod
deregister_targets(target_group_identifier, targets)
deregister_targets(target_group_identifier, targets, params::Dict{String,<:Any})

Deregisters the specified targets from the specified target group.

Arguments

  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.
  • targets: The targets to deregister.
Main.Vpc_Lattice.get_access_log_subscriptionMethod
get_access_log_subscription(access_log_subscription_identifier)
get_access_log_subscription(access_log_subscription_identifier, params::Dict{String,<:Any})

Retrieves information about the specified access log subscription.

Arguments

  • access_log_subscription_identifier: The ID or Amazon Resource Name (ARN) of the access log subscription.
Main.Vpc_Lattice.get_auth_policyMethod
get_auth_policy(resource_identifier)
get_auth_policy(resource_identifier, params::Dict{String,<:Any})

Retrieves information about the auth policy for the specified service or service network.

Arguments

  • resource_identifier: The ID or Amazon Resource Name (ARN) of the service network or service.
Main.Vpc_Lattice.get_listenerMethod
get_listener(listener_identifier, service_identifier)
get_listener(listener_identifier, service_identifier, params::Dict{String,<:Any})

Retrieves information about the specified listener for the specified service.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.get_resource_policyMethod
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})

Retrieves information about the resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the service network or service.
Main.Vpc_Lattice.get_ruleMethod
get_rule(listener_identifier, rule_identifier, service_identifier)
get_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})

Retrieves information about listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • rule_identifier: The ID or Amazon Resource Name (ARN) of the listener rule.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.get_serviceMethod
get_service(service_identifier)
get_service(service_identifier, params::Dict{String,<:Any})

Retrieves information about the specified service.

Arguments

  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.get_service_networkMethod
get_service_network(service_network_identifier)
get_service_network(service_network_identifier, params::Dict{String,<:Any})

Retrieves information about the specified service network.

Arguments

  • service_network_identifier: The ID or Amazon Resource Name (ARN) of the service network.
Main.Vpc_Lattice.get_service_network_service_associationMethod
get_service_network_service_association(service_network_service_association_identifier)
get_service_network_service_association(service_network_service_association_identifier, params::Dict{String,<:Any})

Retrieves information about the specified association between a service network and a service.

Arguments

  • service_network_service_association_identifier: The ID or Amazon Resource Name (ARN) of the association.
Main.Vpc_Lattice.get_service_network_vpc_associationMethod
get_service_network_vpc_association(service_network_vpc_association_identifier)
get_service_network_vpc_association(service_network_vpc_association_identifier, params::Dict{String,<:Any})

Retrieves information about the association between a service network and a VPC.

Arguments

  • service_network_vpc_association_identifier: The ID or Amazon Resource Name (ARN) of the association.
Main.Vpc_Lattice.get_target_groupMethod
get_target_group(target_group_identifier)
get_target_group(target_group_identifier, params::Dict{String,<:Any})

Retrieves information about the specified target group.

Arguments

  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.
Main.Vpc_Lattice.list_access_log_subscriptionsMethod
list_access_log_subscriptions(resource_identifier)
list_access_log_subscriptions(resource_identifier, params::Dict{String,<:Any})

Lists all access log subscriptions for the specified service network or service.

Arguments

  • resource_identifier: The ID or Amazon Resource Name (ARN) of the service network or service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
Main.Vpc_Lattice.list_listenersMethod
list_listeners(service_identifier)
list_listeners(service_identifier, params::Dict{String,<:Any})

Lists the listeners for the specified service.

Arguments

  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
Main.Vpc_Lattice.list_rulesMethod
list_rules(listener_identifier, service_identifier)
list_rules(listener_identifier, service_identifier, params::Dict{String,<:Any})

Lists the rules for the listener.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
Main.Vpc_Lattice.list_service_network_service_associationsMethod
list_service_network_service_associations()
list_service_network_service_associations(params::Dict{String,<:Any})

Lists the associations between the service network and the service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier. Every association in Amazon VPC Lattice is given a unique Amazon Resource Name (ARN), such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource that is shared with another account, the association will include the local account ID as the prefix in the ARN for each account the resource is shared with.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
  • "serviceIdentifier": The ID or Amazon Resource Name (ARN) of the service.
  • "serviceNetworkIdentifier": The ID or Amazon Resource Name (ARN) of the service network.
Main.Vpc_Lattice.list_service_network_vpc_associationsMethod
list_service_network_vpc_associations()
list_service_network_vpc_associations(params::Dict{String,<:Any})

Lists the service network and VPC associations. You can filter the list either by VPC or service network. You must provide either the service network identifier or the VPC identifier.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
  • "serviceNetworkIdentifier": The ID or Amazon Resource Name (ARN) of the service network.
  • "vpcIdentifier": The ID or Amazon Resource Name (ARN) of the VPC.
Main.Vpc_Lattice.list_service_networksMethod
list_service_networks()
list_service_networks(params::Dict{String,<:Any})

Lists the service networks owned by the caller account or shared with the caller account. Also includes the account ID in the ARN to show which account owns the service network.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
Main.Vpc_Lattice.list_servicesMethod
list_services()
list_services(params::Dict{String,<:Any})

Lists the services owned by the caller account or shared with the caller account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
Main.Vpc_Lattice.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags for the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Vpc_Lattice.list_target_groupsMethod
list_target_groups()
list_target_groups(params::Dict{String,<:Any})

Lists your target groups. You can narrow your search by using the filters below in your request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
  • "targetGroupType": The target group type.
  • "vpcIdentifier": The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.list_targetsMethod
list_targets(target_group_identifier)
list_targets(target_group_identifier, params::Dict{String,<:Any})

Lists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.

Arguments

  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return.
  • "nextToken": A pagination token for the next page of results.
  • "targets": The targets to list.
Main.Vpc_Lattice.put_auth_policyMethod
put_auth_policy(policy, resource_identifier)
put_auth_policy(policy, resource_identifier, params::Dict{String,<:Any})

Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.

Arguments

  • policy: The auth policy. The policy string in JSON must not contain newlines or blank lines.
  • resource_identifier: The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
Main.Vpc_Lattice.put_resource_policyMethod
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})

Attaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.

Arguments

  • policy: An IAM policy. The policy string in JSON must not contain newlines or blank lines.
  • resource_arn: The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
Main.Vpc_Lattice.register_targetsMethod
register_targets(target_group_identifier, targets)
register_targets(target_group_identifier, targets, params::Dict{String,<:Any})

Registers the targets with the target group. If it's a Lambda target, you can only have one target in a target group.

Arguments

  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.
  • targets: The targets.
Main.Vpc_Lattice.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds the specified tags to the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tags: The tags for the resource.
Main.Vpc_Lattice.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes the specified tags from the specified resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tag_keys: The tag keys of the tags to remove.
Main.Vpc_Lattice.update_access_log_subscriptionMethod
update_access_log_subscription(access_log_subscription_identifier, destination_arn)
update_access_log_subscription(access_log_subscription_identifier, destination_arn, params::Dict{String,<:Any})

Updates the specified access log subscription.

Arguments

  • access_log_subscription_identifier: The ID or Amazon Resource Name (ARN) of the access log subscription.
  • destination_arn: The Amazon Resource Name (ARN) of the access log destination.
Main.Vpc_Lattice.update_listenerMethod
update_listener(default_action, listener_identifier, service_identifier)
update_listener(default_action, listener_identifier, service_identifier, params::Dict{String,<:Any})

Updates the specified listener for the specified service.

Arguments

  • default_action: The action for the default rule.
  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.
Main.Vpc_Lattice.update_ruleMethod
update_rule(listener_identifier, rule_identifier, service_identifier)
update_rule(listener_identifier, rule_identifier, service_identifier, params::Dict{String,<:Any})

Updates a rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.

Arguments

  • listener_identifier: The ID or Amazon Resource Name (ARN) of the listener.
  • rule_identifier: The ID or Amazon Resource Name (ARN) of the rule.
  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "action": Information about the action for the specified listener rule.
  • "match": The rule match.
  • "priority": The rule priority. A listener can't have multiple rules with the same priority.
Main.Vpc_Lattice.update_serviceMethod
update_service(service_identifier)
update_service(service_identifier, params::Dict{String,<:Any})

Updates the specified service.

Arguments

  • service_identifier: The ID or Amazon Resource Name (ARN) of the service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authType": The type of IAM policy. NONE: The resource does not use an IAM policy. This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
  • "certificateArn": The Amazon Resource Name (ARN) of the certificate.
Main.Vpc_Lattice.update_service_networkMethod
update_service_network(auth_type, service_network_identifier)
update_service_network(auth_type, service_network_identifier, params::Dict{String,<:Any})

Updates the specified service network.

Arguments

  • auth_type: The type of IAM policy. NONE: The resource does not use an IAM policy. This is the default. AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.
  • service_network_identifier: The ID or Amazon Resource Name (ARN) of the service network.
Main.Vpc_Lattice.update_service_network_vpc_associationMethod
update_service_network_vpc_association(security_group_ids, service_network_vpc_association_identifier)
update_service_network_vpc_association(security_group_ids, service_network_vpc_association_identifier, params::Dict{String,<:Any})

Updates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

Arguments

  • security_group_ids: The IDs of the security groups.
  • service_network_vpc_association_identifier: The ID or Amazon Resource Name (ARN) of the association.
Main.Vpc_Lattice.update_target_groupMethod
update_target_group(health_check, target_group_identifier)
update_target_group(health_check, target_group_identifier, params::Dict{String,<:Any})

Updates the specified target group.

Arguments

  • health_check: The health check configuration.
  • target_group_identifier: The ID or Amazon Resource Name (ARN) of the target group.