VPCLattice / Client / create_target_group

create_target_group#

VPCLattice.Client.create_target_group(**kwargs)#

Creates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service.

For more information, see Target groups in the Amazon VPC Lattice User Guide.

Request Syntax

response = client.create_target_group(
    clientToken='string',
    config={
        'healthCheck': {
            'enabled': True|False,
            'healthCheckIntervalSeconds': 123,
            'healthCheckTimeoutSeconds': 123,
            'healthyThresholdCount': 123,
            'matcher': {
                'httpCode': 'string'
            },
            'path': 'string',
            'port': 123,
            'protocol': 'HTTP'|'HTTPS',
            'protocolVersion': 'HTTP1'|'HTTP2',
            'unhealthyThresholdCount': 123
        },
        'ipAddressType': 'IPV4'|'IPV6',
        'port': 123,
        'protocol': 'HTTP'|'HTTPS',
        'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC',
        'vpcIdentifier': 'string'
    },
    name='string',
    tags={
        'string': 'string'
    },
    type='IP'|'LAMBDA'|'INSTANCE'|'ALB'
)

Parameters:

clientToken (string) –
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.

This field is autopopulated if not provided.
config (dict) –
The target group configuration. If type is set to LAMBDA, this parameter doesn’t apply.
- healthCheck (dict) –
  
  The health check configuration.
  - enabled (boolean) –
    
    Indicates whether health checking is enabled.
  - healthCheckIntervalSeconds (integer) –
    
    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.
  - healthCheckTimeoutSeconds (integer) –
    
    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.
  - healthyThresholdCount (integer) –
    
    The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
  - matcher (dict) –
    
    The codes to use when checking for a successful response from a target. These are called Success codes in the console.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: httpCode.
    - httpCode (string) –
      
      The HTTP code to use when checking for a successful response from a target.
  - path (string) –
    
    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.
  - port (integer) –
    
    The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
  - protocol (string) –
    
    The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
  - protocolVersion (string) –
    
    The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
  - unhealthyThresholdCount (integer) –
    
    The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
- ipAddressType (string) –
  
  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 IP address type defaults to ipv4.
- port (integer) – [REQUIRED]
  
  The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443
- protocol (string) – [REQUIRED]
  
  The protocol to use for routing traffic to the targets. Default is the protocol of a target group.
- protocolVersion (string) –
  
  The protocol version. Default value is HTTP1.
- vpcIdentifier (string) – [REQUIRED]
  
  The ID of the VPC.
name (string) –
[REQUIRED]

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.
tags (dict) –
The tags for the target group.
- (string) –
  
  The key of the tag.
  
  Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.
  - (string) –
    
    The value of the tag.
    
    Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @
type (string) –
[REQUIRED]

The type of target group.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'config': {
        'healthCheck': {
            'enabled': True|False,
            'healthCheckIntervalSeconds': 123,
            'healthCheckTimeoutSeconds': 123,
            'healthyThresholdCount': 123,
            'matcher': {
                'httpCode': 'string'
            },
            'path': 'string',
            'port': 123,
            'protocol': 'HTTP'|'HTTPS',
            'protocolVersion': 'HTTP1'|'HTTP2',
            'unhealthyThresholdCount': 123
        },
        'ipAddressType': 'IPV4'|'IPV6',
        'port': 123,
        'protocol': 'HTTP'|'HTTPS',
        'protocolVersion': 'HTTP1'|'HTTP2'|'GRPC',
        'vpcIdentifier': 'string'
    },
    'id': 'string',
    'name': 'string',
    'status': 'CREATE_IN_PROGRESS'|'ACTIVE'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED',
    'type': 'IP'|'LAMBDA'|'INSTANCE'|'ALB'
}

Response Structure

(dict) –
- arn (string) –
  
  The Amazon Resource Name (ARN) of the target group.
- config (dict) –
  
  The target group configuration. If type is set to LAMBDA, this parameter doesn’t apply.
  - healthCheck (dict) –
    
    The health check configuration.
    - enabled (boolean) –
      
      Indicates whether health checking is enabled.
    - healthCheckIntervalSeconds (integer) –
      
      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.
    - healthCheckTimeoutSeconds (integer) –
      
      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.
    - healthyThresholdCount (integer) –
      
      The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.
    - matcher (dict) –
      
      The codes to use when checking for a successful response from a target. These are called Success codes in the console.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: httpCode. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - httpCode (string) –
        
        The HTTP code to use when checking for a successful response from a target.
    - path (string) –
      
      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.
    - port (integer) –
      
      The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.
    - protocol (string) –
      
      The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
    - protocolVersion (string) –
      
      The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
    - unhealthyThresholdCount (integer) –
      
      The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.
  - ipAddressType (string) –
    
    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 IP address type defaults to ipv4.
  - port (integer) –
    
    The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443
  - protocol (string) –
    
    The protocol to use for routing traffic to the targets. Default is the protocol of a target group.
  - protocolVersion (string) –
    
    The protocol version. Default value is HTTP1.
  - vpcIdentifier (string) –
    
    The ID of the VPC.
- id (string) –
  
  The ID of the target group.
- name (string) –
  
  The name of the target group.
- status (string) –
  
  The operation’s 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.
- type (string) –
  
  The type of target group.

Exceptions

VPCLattice.Client.exceptions.ValidationException
VPCLattice.Client.exceptions.AccessDeniedException
VPCLattice.Client.exceptions.ThrottlingException
VPCLattice.Client.exceptions.ResourceNotFoundException
VPCLattice.Client.exceptions.ConflictException
VPCLattice.Client.exceptions.ServiceQuotaExceededException
VPCLattice.Client.exceptions.InternalServerException