# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::VPCLattice module Types # The user does not have sufficient access to perform this action. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Summary information about an access log subscription. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the access log subscription # @return [String] # # @!attribute [rw] created_at # The date and time that the access log subscription was created, # specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] destination_arn # The Amazon Resource Name (ARN) of the destination. # @return [String] # # @!attribute [rw] id # The ID of the access log subscription. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the access log subscription was last updated, # specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the service or service network. # @return [String] # # @!attribute [rw] resource_id # The ID of the service or service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/AccessLogSubscriptionSummary AWS API Documentation # class AccessLogSubscriptionSummary < Struct.new( :arn, :created_at, :destination_arn, :id, :last_updated_at, :resource_arn, :resource_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] rules # The rules for the specified listener. # @return [Array] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/BatchUpdateRuleRequest AWS API Documentation # class BatchUpdateRuleRequest < Struct.new( :listener_identifier, :rules, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] successful # The rules that were successfully updated. # @return [Array] # # @!attribute [rw] unsuccessful # The rules that the operation couldn't update. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/BatchUpdateRuleResponse AWS API Documentation # class BatchUpdateRuleResponse < Struct.new( :successful, :unsuccessful) SENSITIVE = [] include Aws::Structure end # The request conflicts with the current state of the resource. Updating # or deleting a resource can cause an inconsistent state. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_id # The resource ID. # @return [String] # # @!attribute [rw] resource_type # The resource type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message, :resource_id, :resource_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] resource_identifier # The ID or Amazon Resource Name (ARN) of the service network or # service. # @return [String] # # @!attribute [rw] tags # The tags for the access log subscription. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateAccessLogSubscriptionRequest AWS API Documentation # class CreateAccessLogSubscriptionRequest < Struct.new( :client_token, :destination_arn, :resource_identifier, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @!attribute [rw] destination_arn # The Amazon Resource Name (ARN) of the log destination. # @return [String] # # @!attribute [rw] id # The ID of the access log subscription. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the service network or service. # @return [String] # # @!attribute [rw] resource_id # The ID of the service network or service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateAccessLogSubscriptionResponse AWS API Documentation # class CreateAccessLogSubscriptionResponse < Struct.new( :arn, :destination_arn, :id, :resource_arn, :resource_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] default_action # The action for the default rule. Each listener has a default rule. # The default rule is used if no other rules match. # @return [Types::RuleAction] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] 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. # @return [Integer] # # @!attribute [rw] protocol # The listener protocol. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] tags # The tags for the listener. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateListenerRequest AWS API Documentation # class CreateListenerRequest < Struct.new( :client_token, :default_action, :name, :port, :protocol, :service_identifier, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] default_action # The action for the default rule. # @return [Types::RuleAction] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] port # The port number of the listener. # @return [Integer] # # @!attribute [rw] protocol # The protocol of the listener. # @return [String] # # @!attribute [rw] service_arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_id # The ID of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateListenerResponse AWS API Documentation # class CreateListenerResponse < Struct.new( :arn, :default_action, :id, :name, :port, :protocol, :service_arn, :service_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] action # The action for the default rule. # @return [Types::RuleAction] # # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] 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. # @return [Integer] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] tags # The tags for the rule. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateRuleRequest AWS API Documentation # class CreateRuleRequest < Struct.new( :action, :client_token, :listener_identifier, :match, :name, :priority, :service_identifier, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] action # The rule action. # @return [Types::RuleAction] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the rule. # @return [String] # # @!attribute [rw] id # The ID of the rule. # @return [String] # # @!attribute [rw] match # The rule match. The `RuleMatch` must be an `HttpMatch`. This means # that the rule should be an exact match on HTTP constraints which are # made up of the HTTP method, path, and header. # @return [Types::RuleMatch] # # @!attribute [rw] name # The name of the rule. # @return [String] # # @!attribute [rw] priority # The priority assigned to the rule. The lower the priority number the # higher the priority. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateRuleResponse AWS API Documentation # class CreateRuleResponse < Struct.new( :action, :arn, :id, :match, :name, :priority) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] tags # The tags for the service network. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkRequest AWS API Documentation # class CreateServiceNetworkRequest < Struct.new( :auth_type, :client_token, :name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] id # The ID of the service network. # @return [String] # # @!attribute [rw] name # The name of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkResponse AWS API Documentation # class CreateServiceNetworkResponse < Struct.new( :arn, :auth_type, :id, :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] tags # The tags for the association. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkServiceAssociationRequest AWS API Documentation # class CreateServiceNetworkServiceAssociationRequest < Struct.new( :client_token, :service_identifier, :service_network_identifier, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The DNS name of the service. # @return [Types::DnsEntry] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] status # The association status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkServiceAssociationResponse AWS API Documentation # class CreateServiceNetworkServiceAssociationResponse < Struct.new( :arn, :created_by, :custom_domain_name, :dns_entry, :id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] security_group_ids # 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][1] in the # *Amazon VPC User Guide*. # # # # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html # @return [Array] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] tags # The tags for the association. # @return [Hash] # # @!attribute [rw] vpc_identifier # The ID of the VPC. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkVpcAssociationRequest AWS API Documentation # class CreateServiceNetworkVpcAssociationRequest < Struct.new( :client_token, :security_group_ids, :service_network_identifier, :tags, :vpc_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] security_group_ids # The IDs of the security groups. # @return [Array] # # @!attribute [rw] status # The association status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceNetworkVpcAssociationResponse AWS API Documentation # class CreateServiceNetworkVpcAssociationResponse < Struct.new( :arn, :created_by, :id, :security_group_ids, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] tags # The tags for the service. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceRequest AWS API Documentation # class CreateServiceRequest < Struct.new( :auth_type, :certificate_arn, :client_token, :custom_domain_name, :name, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The public DNS name of the service. # @return [Types::DnsEntry] # # @!attribute [rw] id # The ID of the service. # @return [String] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] status # The status. If the status is `CREATE_FAILED`, you must delete and # recreate the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateServiceResponse AWS API Documentation # class CreateServiceResponse < Struct.new( :arn, :auth_type, :certificate_arn, :custom_domain_name, :dns_entry, :id, :name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_token # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] config # The target group configuration. # @return [Types::TargetGroupConfig] # # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] tags # The tags for the target group. # @return [Hash] # # @!attribute [rw] type # The type of target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateTargetGroupRequest AWS API Documentation # class CreateTargetGroupRequest < Struct.new( :client_token, :config, :name, :tags, :type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] config # The target group configuration. # @return [Types::TargetGroupConfig] # # @!attribute [rw] id # The ID of the target group. # @return [String] # # @!attribute [rw] name # The name of the target group. # @return [String] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `CREATE_FAILED`. However, if you retry it while the status is # `CREATE_IN_PROGRESS`, there is no change in the status. # @return [String] # # @!attribute [rw] type # The type of target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/CreateTargetGroupResponse AWS API Documentation # class CreateTargetGroupResponse < Struct.new( :arn, :config, :id, :name, :status, :type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] access_log_subscription_identifier # The ID or Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteAccessLogSubscriptionRequest AWS API Documentation # class DeleteAccessLogSubscriptionRequest < Struct.new( :access_log_subscription_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteAccessLogSubscriptionResponse AWS API Documentation # class DeleteAccessLogSubscriptionResponse < Aws::EmptyStructure; end # @!attribute [rw] resource_identifier # The ID or Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteAuthPolicyRequest AWS API Documentation # class DeleteAuthPolicyRequest < Struct.new( :resource_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteAuthPolicyResponse AWS API Documentation # class DeleteAuthPolicyResponse < Aws::EmptyStructure; end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteListenerRequest AWS API Documentation # class DeleteListenerRequest < Struct.new( :listener_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteListenerResponse AWS API Documentation # class DeleteListenerResponse < Aws::EmptyStructure; end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteResourcePolicyRequest AWS API Documentation # class DeleteResourcePolicyRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteResourcePolicyResponse AWS API Documentation # class DeleteResourcePolicyResponse < Aws::EmptyStructure; end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] rule_identifier # The ID or Amazon Resource Name (ARN) of the rule. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteRuleRequest AWS API Documentation # class DeleteRuleRequest < Struct.new( :listener_identifier, :rule_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteRuleResponse AWS API Documentation # class DeleteRuleResponse < Aws::EmptyStructure; end # @!attribute [rw] service_network_identifier # The Amazon Resource Name (ARN) or ID of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkRequest AWS API Documentation # class DeleteServiceNetworkRequest < Struct.new( :service_network_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkResponse AWS API Documentation # class DeleteServiceNetworkResponse < Aws::EmptyStructure; end # @!attribute [rw] service_network_service_association_identifier # The ID or Amazon Resource Name (ARN) of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkServiceAssociationRequest AWS API Documentation # class DeleteServiceNetworkServiceAssociationRequest < Struct.new( :service_network_service_association_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `DELETE_FAILED`. However, if you retry it when the status is # `DELETE_IN_PROGRESS`, there is no change in the status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkServiceAssociationResponse AWS API Documentation # class DeleteServiceNetworkServiceAssociationResponse < Struct.new( :arn, :id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_network_vpc_association_identifier # The ID or Amazon Resource Name (ARN) of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkVpcAssociationRequest AWS API Documentation # class DeleteServiceNetworkVpcAssociationRequest < Struct.new( :service_network_vpc_association_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `DELETE_FAILED`. However, if you retry it while the status is # `DELETE_IN_PROGRESS`, there is no change in the status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceNetworkVpcAssociationResponse AWS API Documentation # class DeleteServiceNetworkVpcAssociationResponse < Struct.new( :arn, :id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceRequest AWS API Documentation # class DeleteServiceRequest < Struct.new( :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] id # The ID of the service. # @return [String] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `DELETE_FAILED`. However, if you retry it while the status is # `DELETE_IN_PROGRESS`, the status doesn't change. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteServiceResponse AWS API Documentation # class DeleteServiceResponse < Struct.new( :arn, :id, :name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteTargetGroupRequest AWS API Documentation # class DeleteTargetGroupRequest < Struct.new( :target_group_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] id # The ID of the target group. # @return [String] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `DELETE_FAILED`. However, if you retry it while the status is # `DELETE_IN_PROGRESS`, the status doesn't change. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeleteTargetGroupResponse AWS API Documentation # class DeleteTargetGroupResponse < Struct.new( :arn, :id, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] targets # The targets to deregister. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeregisterTargetsRequest AWS API Documentation # class DeregisterTargetsRequest < Struct.new( :target_group_identifier, :targets) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] successful # The targets that were successfully deregistered. # @return [Array] # # @!attribute [rw] unsuccessful # The targets that the operation couldn't deregister. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DeregisterTargetsResponse AWS API Documentation # class DeregisterTargetsResponse < Struct.new( :successful, :unsuccessful) SENSITIVE = [] include Aws::Structure end # Describes the DNS information of a service. # # @!attribute [rw] domain_name # The domain name of the service. # @return [String] # # @!attribute [rw] hosted_zone_id # The ID of the hosted zone. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/DnsEntry AWS API Documentation # class DnsEntry < Struct.new( :domain_name, :hosted_zone_id) SENSITIVE = [] include Aws::Structure end # Describes an action that returns a custom HTTP response. # # @!attribute [rw] status_code # The HTTP response code. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/FixedResponseAction AWS API Documentation # class FixedResponseAction < Struct.new( :status_code) SENSITIVE = [] include Aws::Structure end # Describes a forward action. You can use forward actions to route # requests to one or more target groups. # # @!attribute [rw] target_groups # The target groups. Traffic matching the rule is forwarded to the # specified target groups. With forward actions, you can assign a # weight that controls the prioritization and selection of each target # group. This means that requests are distributed to individual target # groups based on their weights. For example, if two target groups # have the same weight, each target group receives half of the # traffic. # # The default value is 1. This means that if only one target group is # provided, there is no need to set the weight; 100% of the traffic # goes to that target group. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ForwardAction AWS API Documentation # class ForwardAction < Struct.new( :target_groups) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] access_log_subscription_identifier # The ID or Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetAccessLogSubscriptionRequest AWS API Documentation # class GetAccessLogSubscriptionRequest < Struct.new( :access_log_subscription_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @!attribute [rw] created_at # The date and time that the access log subscription was created, # specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] destination_arn # The Amazon Resource Name (ARN) of the access log destination. # @return [String] # # @!attribute [rw] id # The ID of the access log subscription. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the access log subscription was last updated, # specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the service network or service. # @return [String] # # @!attribute [rw] resource_id # The ID of the service network or service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetAccessLogSubscriptionResponse AWS API Documentation # class GetAccessLogSubscriptionResponse < Struct.new( :arn, :created_at, :destination_arn, :id, :last_updated_at, :resource_arn, :resource_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_identifier # The ID or Amazon Resource Name (ARN) of the service network or # service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetAuthPolicyRequest AWS API Documentation # class GetAuthPolicyRequest < Struct.new( :resource_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] created_at # The date and time that the auth policy was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] last_updated_at # The date and time that the auth policy was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] policy # The auth policy. # @return [String] # # @!attribute [rw] state # The state of the auth policy. The auth policy is only active when # the auth type is set to `AWS_IAM`. If you provide a policy, then # authentication and authorization decisions are made based on this # policy and the client's IAM policy. If the auth type is `NONE`, # then any auth policy that you provide remains inactive. For more # information, see [Create a service network][1] in the *Amazon VPC # Lattice User Guide*. # # # # [1]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetAuthPolicyResponse AWS API Documentation # class GetAuthPolicyResponse < Struct.new( :created_at, :last_updated_at, :policy, :state) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetListenerRequest AWS API Documentation # class GetListenerRequest < Struct.new( :listener_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] created_at # The date and time that the listener was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] default_action # The actions for the default listener rule. # @return [Types::RuleAction] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the listener was last updated, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] port # The listener port. # @return [Integer] # # @!attribute [rw] protocol # The listener protocol. # @return [String] # # @!attribute [rw] service_arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_id # The ID of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetListenerResponse AWS API Documentation # class GetListenerResponse < Struct.new( :arn, :created_at, :default_action, :id, :last_updated_at, :name, :port, :protocol, :service_arn, :service_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the service network or service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetResourcePolicyRequest AWS API Documentation # class GetResourcePolicyRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] policy # An IAM policy. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetResourcePolicyResponse AWS API Documentation # class GetResourcePolicyResponse < Struct.new( :policy) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] rule_identifier # The ID or Amazon Resource Name (ARN) of the listener rule. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetRuleRequest AWS API Documentation # class GetRuleRequest < Struct.new( :listener_identifier, :rule_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] action # The action for the default rule. # @return [Types::RuleAction] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] created_at # The date and time that the listener rule was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] is_default # Indicates whether this is the default rule. # @return [Boolean] # # @!attribute [rw] last_updated_at # The date and time that the listener rule was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] priority # The priority level for the specified rule. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetRuleResponse AWS API Documentation # class GetRuleResponse < Struct.new( :action, :arn, :created_at, :id, :is_default, :last_updated_at, :match, :name, :priority) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_network_identifier # The ID or Amazon Resource Name (ARN) of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkRequest AWS API Documentation # class GetServiceNetworkRequest < Struct.new( :service_network_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] created_at # The date and time that the service network was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the service network. # @return [String] # # @!attribute [rw] last_updated_at # The date and time of the last update, specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the service network. # @return [String] # # @!attribute [rw] number_of_associated_services # The number of services associated with the service network. # @return [Integer] # # @!attribute [rw] number_of_associated_vp_cs # The number of VPCs associated with the service network. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkResponse AWS API Documentation # class GetServiceNetworkResponse < Struct.new( :arn, :auth_type, :created_at, :id, :last_updated_at, :name, :number_of_associated_services, :number_of_associated_vp_cs) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_network_service_association_identifier # The ID or Amazon Resource Name (ARN) of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkServiceAssociationRequest AWS API Documentation # class GetServiceNetworkServiceAssociationRequest < Struct.new( :service_network_service_association_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_at # The date and time that the association was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The DNS name of the service. # @return [Types::DnsEntry] # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] id # The ID of the service network and service association. # @return [String] # # @!attribute [rw] service_arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_id # The ID of the service. # @return [String] # # @!attribute [rw] service_name # The name of the service. # @return [String] # # @!attribute [rw] service_network_arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] service_network_id # The ID of the service network. # @return [String] # # @!attribute [rw] service_network_name # The name of the service network. # @return [String] # # @!attribute [rw] status # The status of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkServiceAssociationResponse AWS API Documentation # class GetServiceNetworkServiceAssociationResponse < Struct.new( :arn, :created_at, :created_by, :custom_domain_name, :dns_entry, :failure_code, :failure_message, :id, :service_arn, :service_id, :service_name, :service_network_arn, :service_network_id, :service_network_name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_network_vpc_association_identifier # The ID or Amazon Resource Name (ARN) of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkVpcAssociationRequest AWS API Documentation # class GetServiceNetworkVpcAssociationRequest < Struct.new( :service_network_vpc_association_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_at # The date and time that the association was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] id # The ID of the specified association between the service network and # the VPC. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the association was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] security_group_ids # The IDs of the security groups. # @return [Array] # # @!attribute [rw] service_network_arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] service_network_id # The ID of the service network. # @return [String] # # @!attribute [rw] service_network_name # The name of the service network. # @return [String] # # @!attribute [rw] status # The status of the association. # @return [String] # # @!attribute [rw] vpc_id # The ID of the VPC. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceNetworkVpcAssociationResponse AWS API Documentation # class GetServiceNetworkVpcAssociationResponse < Struct.new( :arn, :created_at, :created_by, :failure_code, :failure_message, :id, :last_updated_at, :security_group_ids, :service_network_arn, :service_network_id, :service_network_name, :status, :vpc_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceRequest AWS API Documentation # class GetServiceRequest < Struct.new( :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] created_at # The date and time that the service was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The DNS name of the service. # @return [Types::DnsEntry] # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] id # The ID of the service. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the service was last updated, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] status # The status of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetServiceResponse AWS API Documentation # class GetServiceResponse < Struct.new( :arn, :auth_type, :certificate_arn, :created_at, :custom_domain_name, :dns_entry, :failure_code, :failure_message, :id, :last_updated_at, :name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetTargetGroupRequest AWS API Documentation # class GetTargetGroupRequest < Struct.new( :target_group_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] config # The target group configuration. # @return [Types::TargetGroupConfig] # # @!attribute [rw] created_at # The date and time that the target group was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] id # The ID of the target group. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the target group was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the target group. # @return [String] # # @!attribute [rw] service_arns # The Amazon Resource Names (ARNs) of the service. # @return [Array] # # @!attribute [rw] status # The status. # @return [String] # # @!attribute [rw] type # The target group type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/GetTargetGroupResponse AWS API Documentation # class GetTargetGroupResponse < Struct.new( :arn, :config, :created_at, :failure_code, :failure_message, :id, :last_updated_at, :name, :service_arns, :status, :type) SENSITIVE = [] include Aws::Structure end # Describes the constraints for a header match. Matches incoming # requests with rule based on request header value before applying rule # action. # # @!attribute [rw] case_sensitive # Indicates whether the match is case sensitive. # @return [Boolean] # # @!attribute [rw] match # The header match type. # @return [Types::HeaderMatchType] # # @!attribute [rw] name # The name of the header. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/HeaderMatch AWS API Documentation # class HeaderMatch < Struct.new( :case_sensitive, :match, :name) SENSITIVE = [] include Aws::Structure end # Describes a header match type. # # @note HeaderMatchType is a union - when making an API calls you must set exactly one of the members. # # @note HeaderMatchType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of HeaderMatchType corresponding to the set member. # # @!attribute [rw] contains # A contains type match. # @return [String] # # @!attribute [rw] exact # An exact type match. # @return [String] # # @!attribute [rw] prefix # A prefix type match. Matches the value with the prefix. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/HeaderMatchType AWS API Documentation # class HeaderMatchType < Struct.new( :contains, :exact, :prefix, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Contains < HeaderMatchType; end class Exact < HeaderMatchType; end class Prefix < HeaderMatchType; end class Unknown < HeaderMatchType; end end # Describes the health check configuration of a target group. Health # check configurations aren't used for target groups of type `LAMBDA` # or `ALB`. # # @!attribute [rw] enabled # Indicates whether health checking is enabled. # @return [Boolean] # # @!attribute [rw] health_check_interval_seconds # The approximate amount of time, in seconds, between health checks of # an individual target. The range is 5–300 seconds. The default is 30 # seconds. # @return [Integer] # # @!attribute [rw] health_check_timeout_seconds # The amount of time, in seconds, to wait before reporting a target as # unhealthy. The range is 1–120 seconds. The default is 5 seconds. # @return [Integer] # # @!attribute [rw] healthy_threshold_count # The number of consecutive successful health checks required before # considering an unhealthy target healthy. The range is 2–10. The # default is 5. # @return [Integer] # # @!attribute [rw] matcher # The codes to use when checking for a successful response from a # target. # @return [Types::Matcher] # # @!attribute [rw] path # The destination for health checks on the targets. If the protocol # version is `HTTP/1.1` or `HTTP/2`, specify a valid URI (for example, # `/path?query`). The default path is `/`. Health checks are not # supported if the protocol version is `gRPC`, however, you can choose # `HTTP/1.1` or `HTTP/2` and specify a valid URI. # @return [String] # # @!attribute [rw] port # The port used when performing health checks on targets. The default # setting is the port that a target receives traffic on. # @return [Integer] # # @!attribute [rw] protocol # The protocol used when performing health checks on targets. The # possible protocols are `HTTP` and `HTTPS`. The default is `HTTP`. # @return [String] # # @!attribute [rw] protocol_version # The protocol version used when performing health checks on targets. # The possible protocol versions are `HTTP1` and `HTTP2`. # @return [String] # # @!attribute [rw] unhealthy_threshold_count # The number of consecutive failed health checks required before # considering a target unhealthy. The range is 2–10. The default is 2. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/HealthCheckConfig AWS API Documentation # class HealthCheckConfig < Struct.new( :enabled, :health_check_interval_seconds, :health_check_timeout_seconds, :healthy_threshold_count, :matcher, :path, :port, :protocol, :protocol_version, :unhealthy_threshold_count) SENSITIVE = [] include Aws::Structure end # Describes criteria that can be applied to incoming requests. # # @!attribute [rw] header_matches # The header matches. Matches incoming requests with rule based on # request header value before applying rule action. # @return [Array] # # @!attribute [rw] method # The HTTP method type. # @return [String] # # @!attribute [rw] path_match # The path match. # @return [Types::PathMatch] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/HttpMatch AWS API Documentation # class HttpMatch < Struct.new( :header_matches, :method, :path_match) SENSITIVE = [] include Aws::Structure end # An unexpected error occurred while processing the request. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] retry_after_seconds # The number of seconds to wait before retrying. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message, :retry_after_seconds) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] resource_identifier # The ID or Amazon Resource Name (ARN) of the service network or # service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListAccessLogSubscriptionsRequest AWS API Documentation # class ListAccessLogSubscriptionsRequest < Struct.new( :max_results, :next_token, :resource_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the access log subscriptions. # @return [Array] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListAccessLogSubscriptionsResponse AWS API Documentation # class ListAccessLogSubscriptionsResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListListenersRequest AWS API Documentation # class ListListenersRequest < Struct.new( :max_results, :next_token, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the listeners. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListListenersResponse AWS API Documentation # class ListListenersResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListRulesRequest AWS API Documentation # class ListRulesRequest < Struct.new( :listener_identifier, :max_results, :next_token, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the rules. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListRulesResponse AWS API Documentation # class ListRulesResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_network_identifier # The ID or Amazon Resource Name (ARN) of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworkServiceAssociationsRequest AWS API Documentation # class ListServiceNetworkServiceAssociationsRequest < Struct.new( :max_results, :next_token, :service_identifier, :service_network_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the associations. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworkServiceAssociationsResponse AWS API Documentation # class ListServiceNetworkServiceAssociationsResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] service_network_identifier # The ID or Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] vpc_identifier # The ID or Amazon Resource Name (ARN) of the VPC. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworkVpcAssociationsRequest AWS API Documentation # class ListServiceNetworkVpcAssociationsRequest < Struct.new( :max_results, :next_token, :service_network_identifier, :vpc_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the associations. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworkVpcAssociationsResponse AWS API Documentation # class ListServiceNetworkVpcAssociationsResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworksRequest AWS API Documentation # class ListServiceNetworksRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the service networks. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServiceNetworksResponse AWS API Documentation # class ListServiceNetworksResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServicesRequest AWS API Documentation # class ListServicesRequest < Struct.new( :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the services. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServicesResponse AWS API Documentation # class ListServicesResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tags # Information about the tags. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] target_group_type # The target group type. # @return [String] # # @!attribute [rw] vpc_identifier # The ID or Amazon Resource Name (ARN) of the VPC. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTargetGroupsRequest AWS API Documentation # class ListTargetGroupsRequest < Struct.new( :max_results, :next_token, :target_group_type, :vpc_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the target groups. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTargetGroupsResponse AWS API Documentation # class ListTargetGroupsResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # A pagination token for the next page of results. # @return [String] # # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] targets # The targets. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTargetsRequest AWS API Documentation # class ListTargetsRequest < Struct.new( :max_results, :next_token, :target_group_identifier, :targets) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] items # Information about the targets. # @return [Array] # # @!attribute [rw] next_token # If there are additional results, a pagination token for the next # page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListTargetsResponse AWS API Documentation # class ListTargetsResponse < Struct.new( :items, :next_token) SENSITIVE = [] include Aws::Structure end # Summary information about a listener. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] created_at # The date and time that the listener was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the listener was last updated, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] port # The listener port. # @return [Integer] # # @!attribute [rw] protocol # The listener protocol. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListenerSummary AWS API Documentation # class ListenerSummary < Struct.new( :arn, :created_at, :id, :last_updated_at, :name, :port, :protocol) SENSITIVE = [] include Aws::Structure end # Describes the codes to use when checking for a successful response # from a target for health checks. # # @note Matcher is a union - when making an API calls you must set exactly one of the members. # # @note Matcher is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Matcher corresponding to the set member. # # @!attribute [rw] http_code # The HTTP code to use when checking for a successful response from a # target. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/Matcher AWS API Documentation # class Matcher < Struct.new( :http_code, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class HttpCode < Matcher; end class Unknown < Matcher; end end # Describes the conditions that can be applied when matching a path for # incoming requests. # # @!attribute [rw] case_sensitive # Indicates whether the match is case sensitive. # @return [Boolean] # # @!attribute [rw] match # The type of path match. # @return [Types::PathMatchType] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PathMatch AWS API Documentation # class PathMatch < Struct.new( :case_sensitive, :match) SENSITIVE = [] include Aws::Structure end # Describes a path match type. Each rule can include only one of the # following types of paths. # # @note PathMatchType is a union - when making an API calls you must set exactly one of the members. # # @note PathMatchType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PathMatchType corresponding to the set member. # # @!attribute [rw] exact # An exact match of the path. # @return [String] # # @!attribute [rw] prefix # A prefix match of the path. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PathMatchType AWS API Documentation # class PathMatchType < Struct.new( :exact, :prefix, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Exact < PathMatchType; end class Prefix < PathMatchType; end class Unknown < PathMatchType; end end # @!attribute [rw] policy # The auth policy. The policy string in JSON must not contain newlines # or blank lines. # @return [String] # # @!attribute [rw] resource_identifier # The ID or Amazon Resource Name (ARN) of the service network or # service for which the policy is created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PutAuthPolicyRequest AWS API Documentation # class PutAuthPolicyRequest < Struct.new( :policy, :resource_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] policy # The auth policy. The policy string in JSON must not contain newlines # or blank lines. # @return [String] # # @!attribute [rw] state # The state of the auth policy. The auth policy is only active when # the auth type is set to `AWS_IAM`. If you provide a policy, then # authentication and authorization decisions are made based on this # policy and the client's IAM policy. If the Auth type is `NONE`, # then, any auth policy that you provide remains inactive. For more # information, see [Create a service network][1] in the *Amazon VPC # Lattice User Guide*. # # # # [1]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html#create-service-network # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PutAuthPolicyResponse AWS API Documentation # class PutAuthPolicyResponse < Struct.new( :policy, :state) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] policy # An IAM policy. The policy string in JSON must not contain newlines # or blank lines. # @return [String] # # @!attribute [rw] resource_arn # The ID or Amazon Resource Name (ARN) of the service network or # service for which the policy is created. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PutResourcePolicyRequest AWS API Documentation # class PutResourcePolicyRequest < Struct.new( :policy, :resource_arn) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/PutResourcePolicyResponse AWS API Documentation # class PutResourcePolicyResponse < Aws::EmptyStructure; end # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] targets # The targets. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RegisterTargetsRequest AWS API Documentation # class RegisterTargetsRequest < Struct.new( :target_group_identifier, :targets) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] successful # The targets that were successfully registered. # @return [Array] # # @!attribute [rw] unsuccessful # The targets that were not registered. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RegisterTargetsResponse AWS API Documentation # class RegisterTargetsResponse < Struct.new( :successful, :unsuccessful) SENSITIVE = [] include Aws::Structure end # The request references a resource that does not exist. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_id # The resource ID. # @return [String] # # @!attribute [rw] resource_type # The resource type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message, :resource_id, :resource_type) SENSITIVE = [] include Aws::Structure end # Describes the action for a rule. # # @note RuleAction is a union - when making an API calls you must set exactly one of the members. # # @note RuleAction is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleAction corresponding to the set member. # # @!attribute [rw] fixed_response # The fixed response action. The rule returns a custom HTTP response. # @return [Types::FixedResponseAction] # # @!attribute [rw] forward # The forward action. Traffic that matches the rule is forwarded to # the specified target groups. # @return [Types::ForwardAction] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleAction AWS API Documentation # class RuleAction < Struct.new( :fixed_response, :forward, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class FixedResponse < RuleAction; end class Forward < RuleAction; end class Unknown < RuleAction; end end # Describes a rule match. # # @note RuleMatch is a union - when making an API calls you must set exactly one of the members. # # @note RuleMatch is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleMatch corresponding to the set member. # # @!attribute [rw] http_match # The HTTP criteria that a rule must match. # @return [Types::HttpMatch] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleMatch AWS API Documentation # class RuleMatch < Struct.new( :http_match, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class HttpMatch < RuleMatch; end class Unknown < RuleMatch; end end # Summary information about the listener rule. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the rule. # @return [String] # # @!attribute [rw] created_at # The date and time that the listener rule was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the rule. # @return [String] # # @!attribute [rw] is_default # Indicates whether this is the default listener rule. # @return [Boolean] # # @!attribute [rw] last_updated_at # The date and time that the listener rule was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the rule. # @return [String] # # @!attribute [rw] priority # The priority of the rule. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleSummary AWS API Documentation # class RuleSummary < Struct.new( :arn, :created_at, :id, :is_default, :last_updated_at, :name, :priority) SENSITIVE = [] include Aws::Structure end # Describes a rule update. # # @!attribute [rw] action # The rule action. # @return [Types::RuleAction] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] priority # The rule priority. A listener can't have multiple rules with the # same priority. # @return [Integer] # # @!attribute [rw] rule_identifier # The ID or Amazon Resource Name (ARN) of the rule. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleUpdate AWS API Documentation # class RuleUpdate < Struct.new( :action, :match, :priority, :rule_identifier) SENSITIVE = [] include Aws::Structure end # Describes a rule update that failed. # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] rule_identifier # The ID or Amazon Resource Name (ARN) of the rule. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleUpdateFailure AWS API Documentation # class RuleUpdateFailure < Struct.new( :failure_code, :failure_message, :rule_identifier) SENSITIVE = [] include Aws::Structure end # Describes a successful rule update. # # @!attribute [rw] action # The action for the rule. # @return [Types::RuleAction] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] is_default # Indicates whether this is the default rule. # @return [Boolean] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] priority # The rule priority. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/RuleUpdateSuccess AWS API Documentation # class RuleUpdateSuccess < Struct.new( :action, :arn, :id, :is_default, :match, :name, :priority) SENSITIVE = [] include Aws::Structure end # Summary information about the association between a service network # and a service. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_at # The date and time that the association was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The DNS information. # @return [Types::DnsEntry] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] service_arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_id # The ID of the service. # @return [String] # # @!attribute [rw] service_name # The name of the service. # @return [String] # # @!attribute [rw] service_network_arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] service_network_id # The ID of the service network. # @return [String] # # @!attribute [rw] service_network_name # The name of the service network. # @return [String] # # @!attribute [rw] status # The status. If the deletion fails, try to delete again. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ServiceNetworkServiceAssociationSummary AWS API Documentation # class ServiceNetworkServiceAssociationSummary < Struct.new( :arn, :created_at, :created_by, :custom_domain_name, :dns_entry, :id, :service_arn, :service_id, :service_name, :service_network_arn, :service_network_id, :service_network_name, :status) SENSITIVE = [] include Aws::Structure end # Summary information about a service network. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] created_at # The date and time that the service network was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the service network. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the service network was last updated, # specified in ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the service network. # @return [String] # # @!attribute [rw] number_of_associated_services # The number of services associated with the service network. # @return [Integer] # # @!attribute [rw] number_of_associated_vp_cs # The number of VPCs associated with the service network. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ServiceNetworkSummary AWS API Documentation # class ServiceNetworkSummary < Struct.new( :arn, :created_at, :id, :last_updated_at, :name, :number_of_associated_services, :number_of_associated_vp_cs) SENSITIVE = [] include Aws::Structure end # Summary information about an association between a service network and # a VPC. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_at # The date and time that the association was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the association was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] service_network_arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] service_network_id # The ID of the service network. # @return [String] # # @!attribute [rw] service_network_name # The name of the service network. # @return [String] # # @!attribute [rw] status # The status. # @return [String] # # @!attribute [rw] vpc_id # The ID of the VPC. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ServiceNetworkVpcAssociationSummary AWS API Documentation # class ServiceNetworkVpcAssociationSummary < Struct.new( :arn, :created_at, :created_by, :id, :last_updated_at, :service_network_arn, :service_network_id, :service_network_name, :status, :vpc_id) SENSITIVE = [] include Aws::Structure end # The request would cause a service quota to be exceeded. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] quota_code # The ID of the service quota that was exceeded. # @return [String] # # @!attribute [rw] resource_id # The resource ID. # @return [String] # # @!attribute [rw] resource_type # The resource type. # @return [String] # # @!attribute [rw] service_code # The service code. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message, :quota_code, :resource_id, :resource_type, :service_code) SENSITIVE = [] include Aws::Structure end # Summary information about a service. # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] created_at # The date and time that the service was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] dns_entry # The DNS information. # @return [Types::DnsEntry] # # @!attribute [rw] id # The ID of the service. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the service was last updated. The format is # ISO-8601. # @return [Time] # # @!attribute [rw] name # The name of the service. # @return [String] # # @!attribute [rw] status # The status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ServiceSummary AWS API Documentation # class ServiceSummary < Struct.new( :arn, :created_at, :custom_domain_name, :dns_entry, :id, :last_updated_at, :name, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] tags # The tags for the resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # Describes a target. # # @!attribute [rw] id # The ID of the target. If the target group type is `INSTANCE`, this # is an instance ID. If the target group type is `IP`, this is an IP # address. If the target group type is `LAMBDA`, this is the ARN of a # Lambda function. If the target group type is `ALB`, this is the ARN # of an Application Load Balancer. # @return [String] # # @!attribute [rw] port # The port on which the target is listening. For HTTP, the default is # 80. For HTTPS, the default is 443. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/Target AWS API Documentation # class Target < Struct.new( :id, :port) SENSITIVE = [] include Aws::Structure end # Describes a target failure. # # @!attribute [rw] failure_code # The failure code. # @return [String] # # @!attribute [rw] failure_message # The failure message. # @return [String] # # @!attribute [rw] id # The ID of the target. If the target group type is `INSTANCE`, this # is an instance ID. If the target group type is `IP`, this is an IP # address. If the target group type is `LAMBDA`, this is the ARN of a # Lambda function. If the target group type is `ALB`, this is the ARN # of an Application Load Balancer. # @return [String] # # @!attribute [rw] port # The port on which the target is listening. This parameter doesn't # apply if the target is a Lambda function. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TargetFailure AWS API Documentation # class TargetFailure < Struct.new( :failure_code, :failure_message, :id, :port) SENSITIVE = [] include Aws::Structure end # Describes the configuration of a target group. # # For more information, see [Target groups][1] in the *Amazon VPC # Lattice User Guide*. # # # # [1]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html # # @!attribute [rw] health_check # The health check configuration. Not supported if the target group # type is `LAMBDA` or `ALB`. # @return [Types::HealthCheckConfig] # # @!attribute [rw] ip_address_type # The type of IP address used for the target group. Supported only if # the target group type is `IP`. The default is `IPV4`. # @return [String] # # @!attribute [rw] lambda_event_structure_version # The version of the event structure that your Lambda function # receives. Supported only if the target group type is `LAMBDA`. The # default is `V1`. # @return [String] # # @!attribute [rw] port # The port on which the targets are listening. For HTTP, the default # is 80. For HTTPS, the default is 443. Not supported if the target # group type is `LAMBDA`. # @return [Integer] # # @!attribute [rw] protocol # The protocol to use for routing traffic to the targets. The default # is the protocol of the target group. Not supported if the target # group type is `LAMBDA`. # @return [String] # # @!attribute [rw] protocol_version # The protocol version. The default is `HTTP1`. Not supported if the # target group type is `LAMBDA`. # @return [String] # # @!attribute [rw] vpc_identifier # The ID of the VPC. Not supported if the target group type is # `LAMBDA`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TargetGroupConfig AWS API Documentation # class TargetGroupConfig < Struct.new( :health_check, :ip_address_type, :lambda_event_structure_version, :port, :protocol, :protocol_version, :vpc_identifier) SENSITIVE = [] include Aws::Structure end # Summary information about a target group. # # For more information, see [Target groups][1] in the *Amazon VPC # Lattice User Guide*. # # # # [1]: https://docs.aws.amazon.com/vpc-lattice/latest/ug/target-groups.html # # @!attribute [rw] arn # The ARN (Amazon Resource Name) of the target group. # @return [String] # # @!attribute [rw] created_at # The date and time that the target group was created, specified in # ISO-8601 format. # @return [Time] # # @!attribute [rw] id # The ID of the target group. # @return [String] # # @!attribute [rw] ip_address_type # The type of IP address used for the target group. The possible # values are `IPV4` and `IPV6`. This is an optional parameter. If not # specified, the default is `IPV4`. # @return [String] # # @!attribute [rw] lambda_event_structure_version # The version of the event structure that your Lambda function # receives. Supported only if the target group type is `LAMBDA`. # @return [String] # # @!attribute [rw] last_updated_at # The date and time that the target group was last updated, specified # in ISO-8601 format. # @return [Time] # # @!attribute [rw] name # The name of the target group. # @return [String] # # @!attribute [rw] port # The port of the target group. # @return [Integer] # # @!attribute [rw] protocol # The protocol of the target group. # @return [String] # # @!attribute [rw] service_arns # The Amazon Resource Names (ARNs) of the service. # @return [Array] # # @!attribute [rw] status # The status. # @return [String] # # @!attribute [rw] type # The target group type. # @return [String] # # @!attribute [rw] vpc_identifier # The ID of the VPC of the target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TargetGroupSummary AWS API Documentation # class TargetGroupSummary < Struct.new( :arn, :created_at, :id, :ip_address_type, :lambda_event_structure_version, :last_updated_at, :name, :port, :protocol, :service_arns, :status, :type, :vpc_identifier) SENSITIVE = [] include Aws::Structure end # Summary information about a target. # # @!attribute [rw] id # The ID of the target. If the target group type is `INSTANCE`, this # is an instance ID. If the target group type is `IP`, this is an IP # address. If the target group type is `LAMBDA`, this is the ARN of a # Lambda function. If the target type is `ALB`, this is the ARN of an # Application Load Balancer. # @return [String] # # @!attribute [rw] port # The port on which the target is listening. # @return [Integer] # # @!attribute [rw] reason_code # The code for why the target status is what it is. # @return [String] # # @!attribute [rw] status # The status of the target. # # * `DRAINING`: The target is being deregistered. No new connections # are sent to this target while current connections are being # drained. The default draining time is 5 minutes. # # * `UNAVAILABLE`: Health checks are unavailable for the target group. # # * `HEALTHY`: The target is healthy. # # * `UNHEALTHY`: The target is unhealthy. # # * `INITIAL`: Initial health checks on the target are being # performed. # # * `UNUSED`: Target group is not used in a service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/TargetSummary AWS API Documentation # class TargetSummary < Struct.new( :id, :port, :reason_code, :status) SENSITIVE = [] include Aws::Structure end # The limit on the number of requests per second was exceeded. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] quota_code # The ID of the service quota that was exceeded. # @return [String] # # @!attribute [rw] retry_after_seconds # The number of seconds to wait before retrying. # @return [Integer] # # @!attribute [rw] service_code # The service code. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :message, :quota_code, :retry_after_seconds, :service_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @!attribute [rw] tag_keys # The tag keys of the tags to remove. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @!attribute [rw] access_log_subscription_identifier # The ID or Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @!attribute [rw] destination_arn # The Amazon Resource Name (ARN) of the access log destination. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateAccessLogSubscriptionRequest AWS API Documentation # class UpdateAccessLogSubscriptionRequest < Struct.new( :access_log_subscription_identifier, :destination_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @!attribute [rw] destination_arn # The Amazon Resource Name (ARN) of the access log destination. # @return [String] # # @!attribute [rw] id # The ID of the access log subscription. # @return [String] # # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the access log subscription. # @return [String] # # @!attribute [rw] resource_id # The ID of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateAccessLogSubscriptionResponse AWS API Documentation # class UpdateAccessLogSubscriptionResponse < Struct.new( :arn, :destination_arn, :id, :resource_arn, :resource_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] default_action # The action for the default rule. # @return [Types::RuleAction] # # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateListenerRequest AWS API Documentation # class UpdateListenerRequest < Struct.new( :default_action, :listener_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] default_action # The action for the default rule. # @return [Types::RuleAction] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] port # The listener port. # @return [Integer] # # @!attribute [rw] protocol # The protocol of the listener. # @return [String] # # @!attribute [rw] service_arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] service_id # The ID of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateListenerResponse AWS API Documentation # class UpdateListenerResponse < Struct.new( :arn, :default_action, :id, :name, :port, :protocol, :service_arn, :service_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] action # Information about the action for the specified listener rule. # @return [Types::RuleAction] # # @!attribute [rw] listener_identifier # The ID or Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] priority # The rule priority. A listener can't have multiple rules with the # same priority. # @return [Integer] # # @!attribute [rw] rule_identifier # The ID or Amazon Resource Name (ARN) of the rule. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateRuleRequest AWS API Documentation # class UpdateRuleRequest < Struct.new( :action, :listener_identifier, :match, :priority, :rule_identifier, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] action # Information about the action for the specified listener rule. # @return [Types::RuleAction] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the listener. # @return [String] # # @!attribute [rw] id # The ID of the listener. # @return [String] # # @!attribute [rw] is_default # Indicates whether this is the default rule. # @return [Boolean] # # @!attribute [rw] match # The rule match. # @return [Types::RuleMatch] # # @!attribute [rw] name # The name of the listener. # @return [String] # # @!attribute [rw] priority # The rule priority. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateRuleResponse AWS API Documentation # class UpdateRuleResponse < Struct.new( :action, :arn, :id, :is_default, :match, :name, :priority) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] service_network_identifier # The ID or Amazon Resource Name (ARN) of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceNetworkRequest AWS API Documentation # class UpdateServiceNetworkRequest < Struct.new( :auth_type, :service_network_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service network. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] id # The ID of the service network. # @return [String] # # @!attribute [rw] name # The name of the service network. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceNetworkResponse AWS API Documentation # class UpdateServiceNetworkResponse < Struct.new( :arn, :auth_type, :id, :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] security_group_ids # The IDs of the security groups. # @return [Array] # # @!attribute [rw] service_network_vpc_association_identifier # The ID or Amazon Resource Name (ARN) of the association. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceNetworkVpcAssociationRequest AWS API Documentation # class UpdateServiceNetworkVpcAssociationRequest < Struct.new( :security_group_ids, :service_network_vpc_association_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the association. # @return [String] # # @!attribute [rw] created_by # The account that created the association. # @return [String] # # @!attribute [rw] id # The ID of the association. # @return [String] # # @!attribute [rw] security_group_ids # The IDs of the security groups. # @return [Array] # # @!attribute [rw] status # The status. You can retry the operation if the status is # `DELETE_FAILED`. However, if you retry it while the status is # `DELETE_IN_PROGRESS`, there is no change in the status. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceNetworkVpcAssociationResponse AWS API Documentation # class UpdateServiceNetworkVpcAssociationResponse < Struct.new( :arn, :created_by, :id, :security_group_ids, :status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] 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. # @return [String] # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] service_identifier # The ID or Amazon Resource Name (ARN) of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceRequest AWS API Documentation # class UpdateServiceRequest < Struct.new( :auth_type, :certificate_arn, :service_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the service. # @return [String] # # @!attribute [rw] auth_type # The type of IAM policy. # @return [String] # # @!attribute [rw] certificate_arn # The Amazon Resource Name (ARN) of the certificate. # @return [String] # # @!attribute [rw] custom_domain_name # The custom domain name of the service. # @return [String] # # @!attribute [rw] id # The ID of the service. # @return [String] # # @!attribute [rw] name # The name of the service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateServiceResponse AWS API Documentation # class UpdateServiceResponse < Struct.new( :arn, :auth_type, :certificate_arn, :custom_domain_name, :id, :name) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] health_check # The health check configuration. # @return [Types::HealthCheckConfig] # # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateTargetGroupRequest AWS API Documentation # class UpdateTargetGroupRequest < Struct.new( :health_check, :target_group_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] config # The target group configuration. # @return [Types::TargetGroupConfig] # # @!attribute [rw] id # The ID of the target group. # @return [String] # # @!attribute [rw] name # The name of the target group. # @return [String] # # @!attribute [rw] status # The status. # @return [String] # # @!attribute [rw] type # The target group type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/UpdateTargetGroupResponse AWS API Documentation # class UpdateTargetGroupResponse < Struct.new( :arn, :config, :id, :name, :status, :type) SENSITIVE = [] include Aws::Structure end # The input does not satisfy the constraints specified by an Amazon Web # Services service. # # @!attribute [rw] field_list # The fields that failed validation. # @return [Array] # # @!attribute [rw] message # @return [String] # # @!attribute [rw] reason # The reason. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ValidationException AWS API Documentation # class ValidationException < Struct.new( :field_list, :message, :reason) SENSITIVE = [] include Aws::Structure end # Describes a validation failure. # # @!attribute [rw] message # Additional information about why the validation failed. # @return [String] # # @!attribute [rw] name # The name of the validation exception. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ValidationExceptionField AWS API Documentation # class ValidationExceptionField < Struct.new( :message, :name) SENSITIVE = [] include Aws::Structure end # Describes the weight of a target group. # # @!attribute [rw] target_group_identifier # The ID or Amazon Resource Name (ARN) of the target group. # @return [String] # # @!attribute [rw] weight # Only required if you specify multiple target groups for a forward # action. The weight determines how requests are distributed to the # target group. For example, if you specify two target groups, each # with a weight of 10, each target group receives half the requests. # If you specify two target groups, one with a weight of 10 and the # other with a weight of 20, the target group with a weight of 20 # receives twice as many requests as the other target group. If # there's only one target group specified, then the default value is # 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/WeightedTargetGroup AWS API Documentation # class WeightedTargetGroup < Struct.new( :target_group_identifier, :weight) SENSITIVE = [] include Aws::Structure end end end