Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. globalaccelerator
  5. CustomRoutingEndpointGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

aws.globalaccelerator.CustomRoutingEndpointGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a Global Accelerator custom routing endpoint group.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.GlobalAccelerator.CustomRoutingEndpointGroup("example", new()
    {
        ListenerArn = aws_globalaccelerator_custom_routing_listener.Example.Id,
        DestinationConfigurations = new[]
        {
            new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupDestinationConfigurationArgs
            {
                FromPort = 80,
                ToPort = 8080,
                Protocols = new[]
                {
                    "TCP",
                },
            },
        },
        EndpointConfigurations = new[]
        {
            new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupEndpointConfigurationArgs
            {
                EndpointId = aws_subnet.Example.Id,
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/globalaccelerator"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globalaccelerator.NewCustomRoutingEndpointGroup(ctx, "example", &globalaccelerator.CustomRoutingEndpointGroupArgs{
			ListenerArn: pulumi.Any(aws_globalaccelerator_custom_routing_listener.Example.Id),
			DestinationConfigurations: globalaccelerator.CustomRoutingEndpointGroupDestinationConfigurationArray{
				&globalaccelerator.CustomRoutingEndpointGroupDestinationConfigurationArgs{
					FromPort: pulumi.Int(80),
					ToPort:   pulumi.Int(8080),
					Protocols: pulumi.StringArray{
						pulumi.String("TCP"),
					},
				},
			},
			EndpointConfigurations: globalaccelerator.CustomRoutingEndpointGroupEndpointConfigurationArray{
				&globalaccelerator.CustomRoutingEndpointGroupEndpointConfigurationArgs{
					EndpointId: pulumi.Any(aws_subnet.Example.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.globalaccelerator.CustomRoutingEndpointGroup;
import com.pulumi.aws.globalaccelerator.CustomRoutingEndpointGroupArgs;
import com.pulumi.aws.globalaccelerator.inputs.CustomRoutingEndpointGroupDestinationConfigurationArgs;
import com.pulumi.aws.globalaccelerator.inputs.CustomRoutingEndpointGroupEndpointConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new CustomRoutingEndpointGroup("example", CustomRoutingEndpointGroupArgs.builder()        
            .listenerArn(aws_globalaccelerator_custom_routing_listener.example().id())
            .destinationConfigurations(CustomRoutingEndpointGroupDestinationConfigurationArgs.builder()
                .fromPort(80)
                .toPort(8080)
                .protocols("TCP")
                .build())
            .endpointConfigurations(CustomRoutingEndpointGroupEndpointConfigurationArgs.builder()
                .endpointId(aws_subnet.example().id())
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.globalaccelerator.CustomRoutingEndpointGroup("example",
    listener_arn=aws_globalaccelerator_custom_routing_listener["example"]["id"],
    destination_configurations=[aws.globalaccelerator.CustomRoutingEndpointGroupDestinationConfigurationArgs(
        from_port=80,
        to_port=8080,
        protocols=["TCP"],
    )],
    endpoint_configurations=[aws.globalaccelerator.CustomRoutingEndpointGroupEndpointConfigurationArgs(
        endpoint_id=aws_subnet["example"]["id"],
    )])

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.globalaccelerator.CustomRoutingEndpointGroup("example", {
    listenerArn: aws_globalaccelerator_custom_routing_listener.example.id,
    destinationConfigurations: [{
        fromPort: 80,
        toPort: 8080,
        protocols: ["TCP"],
    }],
    endpointConfigurations: [{
        endpointId: aws_subnet.example.id,
    }],
});

    resources:
  example:
    type: aws:globalaccelerator:CustomRoutingEndpointGroup
    properties:
      listenerArn: ${aws_globalaccelerator_custom_routing_listener.example.id}
      destinationConfigurations:
        - fromPort: 80
          toPort: 8080
          protocols:
            - TCP
      endpointConfigurations:
        - endpointId: ${aws_subnet.example.id}

    Create CustomRoutingEndpointGroup Resource

    new CustomRoutingEndpointGroup(name: string, args: CustomRoutingEndpointGroupArgs, opts?: CustomResourceOptions);
    @overload
def CustomRoutingEndpointGroup(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               destination_configurations: Optional[Sequence[CustomRoutingEndpointGroupDestinationConfigurationArgs]] = None,
                               endpoint_configurations: Optional[Sequence[CustomRoutingEndpointGroupEndpointConfigurationArgs]] = None,
                               endpoint_group_region: Optional[str] = None,
                               listener_arn: Optional[str] = None)
@overload
def CustomRoutingEndpointGroup(resource_name: str,
                               args: CustomRoutingEndpointGroupArgs,
                               opts: Optional[ResourceOptions] = None)
    func NewCustomRoutingEndpointGroup(ctx *Context, name string, args CustomRoutingEndpointGroupArgs, opts ...ResourceOption) (*CustomRoutingEndpointGroup, error)
    public CustomRoutingEndpointGroup(string name, CustomRoutingEndpointGroupArgs args, CustomResourceOptions? opts = null)
    public CustomRoutingEndpointGroup(String name, CustomRoutingEndpointGroupArgs args)
public CustomRoutingEndpointGroup(String name, CustomRoutingEndpointGroupArgs args, CustomResourceOptions options)

    type: aws:globalaccelerator:CustomRoutingEndpointGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomRoutingEndpointGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomRoutingEndpointGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomRoutingEndpointGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomRoutingEndpointGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomRoutingEndpointGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CustomRoutingEndpointGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The CustomRoutingEndpointGroup resource accepts the following input properties:

    DestinationConfigurations List<CustomRoutingEndpointGroupDestinationConfiguration>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    ListenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    EndpointConfigurations List<CustomRoutingEndpointGroupEndpointConfiguration>

    The list of endpoint objects. Fields documented below.

    EndpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    DestinationConfigurations []CustomRoutingEndpointGroupDestinationConfigurationArgs

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    ListenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    EndpointConfigurations []CustomRoutingEndpointGroupEndpointConfigurationArgs

    The list of endpoint objects. Fields documented below.

    EndpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    destinationConfigurations List<CustomRoutingEndpointGroupDestinationConfiguration>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    listenerArn String

    The Amazon Resource Name (ARN) of the custom routing listener.

    endpointConfigurations List<CustomRoutingEndpointGroupEndpointConfiguration>

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion String

    The name of the AWS Region where the custom routing endpoint group is located.

    destinationConfigurations CustomRoutingEndpointGroupDestinationConfiguration[]

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    listenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    endpointConfigurations CustomRoutingEndpointGroupEndpointConfiguration[]

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    destination_configurations Sequence[CustomRoutingEndpointGroupDestinationConfigurationArgs]

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    listener_arn str

    The Amazon Resource Name (ARN) of the custom routing listener.

    endpoint_configurations Sequence[CustomRoutingEndpointGroupEndpointConfigurationArgs]

    The list of endpoint objects. Fields documented below.

    endpoint_group_region str

    The name of the AWS Region where the custom routing endpoint group is located.

    destinationConfigurations List<Property Map>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    listenerArn String

    The Amazon Resource Name (ARN) of the custom routing listener.

    endpointConfigurations List<Property Map>

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion String

    The name of the AWS Region where the custom routing endpoint group is located.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomRoutingEndpointGroup resource produces the following output properties:

    Arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    Id string

    The provider-assigned unique ID for this managed resource.

    Arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    Id string

    The provider-assigned unique ID for this managed resource.

    arn String

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    id String

    The provider-assigned unique ID for this managed resource.

    arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    id string

    The provider-assigned unique ID for this managed resource.

    arn str

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    id str

    The provider-assigned unique ID for this managed resource.

    arn String

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomRoutingEndpointGroup Resource

    Get an existing CustomRoutingEndpointGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomRoutingEndpointGroupState, opts?: CustomResourceOptions): CustomRoutingEndpointGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        destination_configurations: Optional[Sequence[CustomRoutingEndpointGroupDestinationConfigurationArgs]] = None,
        endpoint_configurations: Optional[Sequence[CustomRoutingEndpointGroupEndpointConfigurationArgs]] = None,
        endpoint_group_region: Optional[str] = None,
        listener_arn: Optional[str] = None) -> CustomRoutingEndpointGroup
    func GetCustomRoutingEndpointGroup(ctx *Context, name string, id IDInput, state *CustomRoutingEndpointGroupState, opts ...ResourceOption) (*CustomRoutingEndpointGroup, error)
    public static CustomRoutingEndpointGroup Get(string name, Input<string> id, CustomRoutingEndpointGroupState? state, CustomResourceOptions? opts = null)
    public static CustomRoutingEndpointGroup get(String name, Output<String> id, CustomRoutingEndpointGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    DestinationConfigurations List<CustomRoutingEndpointGroupDestinationConfiguration>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    EndpointConfigurations List<CustomRoutingEndpointGroupEndpointConfiguration>

    The list of endpoint objects. Fields documented below.

    EndpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    ListenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    Arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    DestinationConfigurations []CustomRoutingEndpointGroupDestinationConfigurationArgs

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    EndpointConfigurations []CustomRoutingEndpointGroupEndpointConfigurationArgs

    The list of endpoint objects. Fields documented below.

    EndpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    ListenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    arn String

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    destinationConfigurations List<CustomRoutingEndpointGroupDestinationConfiguration>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    endpointConfigurations List<CustomRoutingEndpointGroupEndpointConfiguration>

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion String

    The name of the AWS Region where the custom routing endpoint group is located.

    listenerArn String

    The Amazon Resource Name (ARN) of the custom routing listener.

    arn string

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    destinationConfigurations CustomRoutingEndpointGroupDestinationConfiguration[]

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    endpointConfigurations CustomRoutingEndpointGroupEndpointConfiguration[]

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion string

    The name of the AWS Region where the custom routing endpoint group is located.

    listenerArn string

    The Amazon Resource Name (ARN) of the custom routing listener.

    arn str

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    destination_configurations Sequence[CustomRoutingEndpointGroupDestinationConfigurationArgs]

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    endpoint_configurations Sequence[CustomRoutingEndpointGroupEndpointConfigurationArgs]

    The list of endpoint objects. Fields documented below.

    endpoint_group_region str

    The name of the AWS Region where the custom routing endpoint group is located.

    listener_arn str

    The Amazon Resource Name (ARN) of the custom routing listener.

    arn String

    The Amazon Resource Name (ARN) of the custom routing endpoint group.

    destinationConfigurations List<Property Map>

    The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.

    endpointConfigurations List<Property Map>

    The list of endpoint objects. Fields documented below.

    endpointGroupRegion String

    The name of the AWS Region where the custom routing endpoint group is located.

    listenerArn String

    The Amazon Resource Name (ARN) of the custom routing listener.

    Supporting Types

    CustomRoutingEndpointGroupDestinationConfiguration, CustomRoutingEndpointGroupDestinationConfigurationArgs

    FromPort int

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    Protocols List<string>

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    ToPort int

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    FromPort int

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    Protocols []string

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    ToPort int

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    fromPort Integer

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    protocols List<String>

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    toPort Integer

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    fromPort number

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    protocols string[]

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    toPort number

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    from_port int

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    protocols Sequence[str]

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    to_port int

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    fromPort Number

    The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    protocols List<String>

    The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either "TCP" or "UDP".

    toPort Number

    The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    CustomRoutingEndpointGroupEndpointConfiguration, CustomRoutingEndpointGroupEndpointConfigurationArgs

    EndpointId string

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    EndpointId string

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    endpointId String

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    endpointId string

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    endpoint_id str

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    endpointId String

    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

    Import

    Using pulumi import, import Global Accelerator custom routing endpoint groups using the id. For example:

     $ pulumi import aws:globalaccelerator/customRoutingEndpointGroup:CustomRoutingEndpointGroup example arn:aws:globalaccelerator::111111111111:accelerator/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/listener/xxxxxxx/endpoint-group/xxxxxxxx

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.1 published on Friday, Sep 22, 2023 by Pulumi
    pulumi/pulumi-aws