aws.globalaccelerator.CustomRoutingEndpointGroup
Explore with Pulumi AI
Provides a Global Accelerator custom routing endpoint group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.globalaccelerator.CustomRoutingEndpointGroup("example", {
listenerArn: exampleAwsGlobalacceleratorCustomRoutingListener.id,
destinationConfigurations: [{
fromPort: 80,
toPort: 8080,
protocols: ["TCP"],
}],
endpointConfigurations: [{
endpointId: exampleAwsSubnet.id,
}],
});
import pulumi
import pulumi_aws as aws
example = aws.globalaccelerator.CustomRoutingEndpointGroup("example",
listener_arn=example_aws_globalaccelerator_custom_routing_listener["id"],
destination_configurations=[{
"from_port": 80,
"to_port": 8080,
"protocols": ["TCP"],
}],
endpoint_configurations=[{
"endpoint_id": example_aws_subnet["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(exampleAwsGlobalacceleratorCustomRoutingListener.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(exampleAwsSubnet.Id),
},
},
})
if err != nil {
return err
}
return nil
})
}
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 = exampleAwsGlobalacceleratorCustomRoutingListener.Id,
DestinationConfigurations = new[]
{
new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupDestinationConfigurationArgs
{
FromPort = 80,
ToPort = 8080,
Protocols = new[]
{
"TCP",
},
},
},
EndpointConfigurations = new[]
{
new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupEndpointConfigurationArgs
{
EndpointId = exampleAwsSubnet.Id,
},
},
});
});
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(exampleAwsGlobalacceleratorCustomRoutingListener.id())
.destinationConfigurations(CustomRoutingEndpointGroupDestinationConfigurationArgs.builder()
.fromPort(80)
.toPort(8080)
.protocols("TCP")
.build())
.endpointConfigurations(CustomRoutingEndpointGroupEndpointConfigurationArgs.builder()
.endpointId(exampleAwsSubnet.id())
.build())
.build());
}
}
resources:
example:
type: aws:globalaccelerator:CustomRoutingEndpointGroup
properties:
listenerArn: ${exampleAwsGlobalacceleratorCustomRoutingListener.id}
destinationConfigurations:
- fromPort: 80
toPort: 8080
protocols:
- TCP
endpointConfigurations:
- endpointId: ${exampleAwsSubnet.id}
Create CustomRoutingEndpointGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomRoutingEndpointGroup(name: string, args: CustomRoutingEndpointGroupArgs, opts?: CustomResourceOptions);
@overload
def CustomRoutingEndpointGroup(resource_name: str,
args: CustomRoutingEndpointGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomRoutingEndpointGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
destination_configurations: Optional[Sequence[CustomRoutingEndpointGroupDestinationConfigurationArgs]] = None,
listener_arn: Optional[str] = None,
endpoint_configurations: Optional[Sequence[CustomRoutingEndpointGroupEndpointConfigurationArgs]] = None,
endpoint_group_region: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var customRoutingEndpointGroupResource = new Aws.GlobalAccelerator.CustomRoutingEndpointGroup("customRoutingEndpointGroupResource", new()
{
DestinationConfigurations = new[]
{
new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupDestinationConfigurationArgs
{
FromPort = 0,
Protocols = new[]
{
"string",
},
ToPort = 0,
},
},
ListenerArn = "string",
EndpointConfigurations = new[]
{
new Aws.GlobalAccelerator.Inputs.CustomRoutingEndpointGroupEndpointConfigurationArgs
{
EndpointId = "string",
},
},
EndpointGroupRegion = "string",
});
example, err := globalaccelerator.NewCustomRoutingEndpointGroup(ctx, "customRoutingEndpointGroupResource", &globalaccelerator.CustomRoutingEndpointGroupArgs{
DestinationConfigurations: globalaccelerator.CustomRoutingEndpointGroupDestinationConfigurationArray{
&globalaccelerator.CustomRoutingEndpointGroupDestinationConfigurationArgs{
FromPort: pulumi.Int(0),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
ToPort: pulumi.Int(0),
},
},
ListenerArn: pulumi.String("string"),
EndpointConfigurations: globalaccelerator.CustomRoutingEndpointGroupEndpointConfigurationArray{
&globalaccelerator.CustomRoutingEndpointGroupEndpointConfigurationArgs{
EndpointId: pulumi.String("string"),
},
},
EndpointGroupRegion: pulumi.String("string"),
})
var customRoutingEndpointGroupResource = new CustomRoutingEndpointGroup("customRoutingEndpointGroupResource", CustomRoutingEndpointGroupArgs.builder()
.destinationConfigurations(CustomRoutingEndpointGroupDestinationConfigurationArgs.builder()
.fromPort(0)
.protocols("string")
.toPort(0)
.build())
.listenerArn("string")
.endpointConfigurations(CustomRoutingEndpointGroupEndpointConfigurationArgs.builder()
.endpointId("string")
.build())
.endpointGroupRegion("string")
.build());
custom_routing_endpoint_group_resource = aws.globalaccelerator.CustomRoutingEndpointGroup("customRoutingEndpointGroupResource",
destination_configurations=[{
"from_port": 0,
"protocols": ["string"],
"to_port": 0,
}],
listener_arn="string",
endpoint_configurations=[{
"endpoint_id": "string",
}],
endpoint_group_region="string")
const customRoutingEndpointGroupResource = new aws.globalaccelerator.CustomRoutingEndpointGroup("customRoutingEndpointGroupResource", {
destinationConfigurations: [{
fromPort: 0,
protocols: ["string"],
toPort: 0,
}],
listenerArn: "string",
endpointConfigurations: [{
endpointId: "string",
}],
endpointGroupRegion: "string",
});
type: aws:globalaccelerator:CustomRoutingEndpointGroup
properties:
destinationConfigurations:
- fromPort: 0
protocols:
- string
toPort: 0
endpointConfigurations:
- endpointId: string
endpointGroupRegion: string
listenerArn: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CustomRoutingEndpointGroup resource accepts the following input properties:
- Destination
Configurations List<CustomRouting Endpoint Group Destination Configuration> - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- Listener
Arn string - The Amazon Resource Name (ARN) of the custom routing listener.
- Endpoint
Configurations List<CustomRouting Endpoint Group Endpoint Configuration> - The list of endpoint objects. Fields documented below.
- Endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- Destination
Configurations []CustomRouting Endpoint Group Destination Configuration Args - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- Listener
Arn string - The Amazon Resource Name (ARN) of the custom routing listener.
- Endpoint
Configurations []CustomRouting Endpoint Group Endpoint Configuration Args - The list of endpoint objects. Fields documented below.
- Endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- destination
Configurations List<CustomRouting Endpoint Group Destination Configuration> - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- listener
Arn String - The Amazon Resource Name (ARN) of the custom routing listener.
- endpoint
Configurations List<CustomRouting Endpoint Group Endpoint Configuration> - The list of endpoint objects. Fields documented below.
- endpoint
Group StringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- destination
Configurations CustomRouting Endpoint Group Destination Configuration[] - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- listener
Arn string - The Amazon Resource Name (ARN) of the custom routing listener.
- endpoint
Configurations CustomRouting Endpoint Group Endpoint Configuration[] - The list of endpoint objects. Fields documented below.
- endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- destination_
configurations Sequence[CustomRouting Endpoint Group Destination Configuration Args] - 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[CustomRouting Endpoint Group Endpoint Configuration Args] - The list of endpoint objects. Fields documented below.
- endpoint_
group_ strregion - The name of the AWS Region where the custom routing endpoint group is located.
- destination
Configurations 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.
- listener
Arn String - The Amazon Resource Name (ARN) of the custom routing listener.
- endpoint
Configurations List<Property Map> - The list of endpoint objects. Fields documented below.
- endpoint
Group StringRegion - 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:
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.
- Arn string
- The Amazon Resource Name (ARN) of the custom routing endpoint group.
- Destination
Configurations List<CustomRouting Endpoint Group Destination Configuration> - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- Endpoint
Configurations List<CustomRouting Endpoint Group Endpoint Configuration> - The list of endpoint objects. Fields documented below.
- Endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- Listener
Arn string - The Amazon Resource Name (ARN) of the custom routing listener.
- Arn string
- The Amazon Resource Name (ARN) of the custom routing endpoint group.
- Destination
Configurations []CustomRouting Endpoint Group Destination Configuration Args - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- Endpoint
Configurations []CustomRouting Endpoint Group Endpoint Configuration Args - The list of endpoint objects. Fields documented below.
- Endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- Listener
Arn string - The Amazon Resource Name (ARN) of the custom routing listener.
- arn String
- The Amazon Resource Name (ARN) of the custom routing endpoint group.
- destination
Configurations List<CustomRouting Endpoint Group Destination Configuration> - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- endpoint
Configurations List<CustomRouting Endpoint Group Endpoint Configuration> - The list of endpoint objects. Fields documented below.
- endpoint
Group StringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- listener
Arn String - The Amazon Resource Name (ARN) of the custom routing listener.
- arn string
- The Amazon Resource Name (ARN) of the custom routing endpoint group.
- destination
Configurations CustomRouting Endpoint Group Destination Configuration[] - The port ranges and protocols for all endpoints in a custom routing endpoint group to accept client traffic on. Fields documented below.
- endpoint
Configurations CustomRouting Endpoint Group Endpoint Configuration[] - The list of endpoint objects. Fields documented below.
- endpoint
Group stringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- listener
Arn 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[CustomRouting Endpoint Group Destination Configuration Args] - 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[CustomRouting Endpoint Group Endpoint Configuration Args] - The list of endpoint objects. Fields documented below.
- endpoint_
group_ strregion - 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.
- destination
Configurations 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.
- endpoint
Configurations List<Property Map> - The list of endpoint objects. Fields documented below.
- endpoint
Group StringRegion - The name of the AWS Region where the custom routing endpoint group is located.
- listener
Arn String - The Amazon Resource Name (ARN) of the custom routing listener.
Supporting Types
CustomRoutingEndpointGroupDestinationConfiguration, CustomRoutingEndpointGroupDestinationConfigurationArgs
- 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 List<string>
- 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.
- 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 []string
- 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.
- from
Port 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"
. - to
Port Integer - The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
- from
Port 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"
. - to
Port 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.
- from
Port 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"
. - to
Port Number - The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.
CustomRoutingEndpointGroupEndpointConfiguration, CustomRoutingEndpointGroupEndpointConfigurationArgs
- Endpoint
Id string - An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
- Endpoint
Id string - An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
- endpoint
Id String - An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
- endpoint
Id 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.
- endpoint
Id 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.