AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.events.Endpoint

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Example Usage

Example

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

return await Deployment.RunAsync(() => 
{
    var sampleEndpoint = new AwsNative.Events.Endpoint("sampleEndpoint", new()
    {
        Name = "CreateExampleEndpoint",
        RoutingConfig = new AwsNative.Events.Inputs.EndpointRoutingConfigArgs
        {
            FailoverConfig = new AwsNative.Events.Inputs.EndpointFailoverConfigArgs
            {
                Primary = new AwsNative.Events.Inputs.EndpointPrimaryArgs
                {
                    HealthCheck = "arn:aws:route53:::healthcheck/0123456789abc",
                },
                Secondary = new AwsNative.Events.Inputs.EndpointSecondaryArgs
                {
                    Route = "us-east-1",
                },
            },
        },
        ReplicationConfig = new AwsNative.Events.Inputs.EndpointReplicationConfigArgs
        {
            State = AwsNative.Events.EndpointReplicationState.Enabled,
        },
        RoleArn = "arn:aws:iam::123456789012:role/EndpointReplicationRole",
        EventBuses = new[]
        {
            new AwsNative.Events.Inputs.EndpointEventBusArgs
            {
                EventBusArn = "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
            },
            new AwsNative.Events.Inputs.EndpointEventBusArgs
            {
                EventBusArn = "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["sampleEndpointName"] = sampleEndpoint.Id,
    };
});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/events"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sampleEndpoint, err := events.NewEndpoint(ctx, "sampleEndpoint", &events.EndpointArgs{
			Name: pulumi.String("CreateExampleEndpoint"),
			RoutingConfig: &events.EndpointRoutingConfigArgs{
				FailoverConfig: &events.EndpointFailoverConfigArgs{
					Primary: &events.EndpointPrimaryArgs{
						HealthCheck: pulumi.String("arn:aws:route53:::healthcheck/0123456789abc"),
					},
					Secondary: &events.EndpointSecondaryArgs{
						Route: pulumi.String("us-east-1"),
					},
				},
			},
			ReplicationConfig: &events.EndpointReplicationConfigArgs{
				State: events.EndpointReplicationStateEnabled,
			},
			RoleArn: pulumi.String("arn:aws:iam::123456789012:role/EndpointReplicationRole"),
			EventBuses: events.EndpointEventBusArray{
				&events.EndpointEventBusArgs{
					EventBusArn: pulumi.String("arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus"),
				},
				&events.EndpointEventBusArgs{
					EventBusArn: pulumi.String("arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("sampleEndpointName", sampleEndpoint.ID())
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sample_endpoint = aws_native.events.Endpoint("sampleEndpoint",
    name="CreateExampleEndpoint",
    routing_config={
        "failover_config": {
            "primary": {
                "health_check": "arn:aws:route53:::healthcheck/0123456789abc",
            },
            "secondary": {
                "route": "us-east-1",
            },
        },
    },
    replication_config={
        "state": aws_native.events.EndpointReplicationState.ENABLED,
    },
    role_arn="arn:aws:iam::123456789012:role/EndpointReplicationRole",
    event_buses=[
        {
            "event_bus_arn": "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
        },
        {
            "event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
        },
    ])
pulumi.export("sampleEndpointName", sample_endpoint.id)

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleEndpoint = new aws_native.events.Endpoint("sampleEndpoint", {
    name: "CreateExampleEndpoint",
    routingConfig: {
        failoverConfig: {
            primary: {
                healthCheck: "arn:aws:route53:::healthcheck/0123456789abc",
            },
            secondary: {
                route: "us-east-1",
            },
        },
    },
    replicationConfig: {
        state: aws_native.events.EndpointReplicationState.Enabled,
    },
    roleArn: "arn:aws:iam::123456789012:role/EndpointReplicationRole",
    eventBuses: [
        {
            eventBusArn: "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
        },
        {
            eventBusArn: "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
        },
    ],
});
export const sampleEndpointName = sampleEndpoint.id;

Coming soon!

Example

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

return await Deployment.RunAsync(() => 
{
    var sampleEndpoint = new AwsNative.Events.Endpoint("sampleEndpoint", new()
    {
        Name = "CreateExampleEndpoint",
        RoutingConfig = new AwsNative.Events.Inputs.EndpointRoutingConfigArgs
        {
            FailoverConfig = new AwsNative.Events.Inputs.EndpointFailoverConfigArgs
            {
                Primary = new AwsNative.Events.Inputs.EndpointPrimaryArgs
                {
                    HealthCheck = "arn:aws:route53:::healthcheck/0123456789abc",
                },
                Secondary = new AwsNative.Events.Inputs.EndpointSecondaryArgs
                {
                    Route = "us-east-1",
                },
            },
        },
        ReplicationConfig = new AwsNative.Events.Inputs.EndpointReplicationConfigArgs
        {
            State = AwsNative.Events.EndpointReplicationState.Disabled,
        },
        EventBuses = new[]
        {
            new AwsNative.Events.Inputs.EndpointEventBusArgs
            {
                EventBusArn = "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
            },
            new AwsNative.Events.Inputs.EndpointEventBusArgs
            {
                EventBusArn = "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["sampleEndpointName"] = sampleEndpoint.Id,
    };
});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/events"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sampleEndpoint, err := events.NewEndpoint(ctx, "sampleEndpoint", &events.EndpointArgs{
			Name: pulumi.String("CreateExampleEndpoint"),
			RoutingConfig: &events.EndpointRoutingConfigArgs{
				FailoverConfig: &events.EndpointFailoverConfigArgs{
					Primary: &events.EndpointPrimaryArgs{
						HealthCheck: pulumi.String("arn:aws:route53:::healthcheck/0123456789abc"),
					},
					Secondary: &events.EndpointSecondaryArgs{
						Route: pulumi.String("us-east-1"),
					},
				},
			},
			ReplicationConfig: &events.EndpointReplicationConfigArgs{
				State: events.EndpointReplicationStateDisabled,
			},
			EventBuses: events.EndpointEventBusArray{
				&events.EndpointEventBusArgs{
					EventBusArn: pulumi.String("arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus"),
				},
				&events.EndpointEventBusArgs{
					EventBusArn: pulumi.String("arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("sampleEndpointName", sampleEndpoint.ID())
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sample_endpoint = aws_native.events.Endpoint("sampleEndpoint",
    name="CreateExampleEndpoint",
    routing_config={
        "failover_config": {
            "primary": {
                "health_check": "arn:aws:route53:::healthcheck/0123456789abc",
            },
            "secondary": {
                "route": "us-east-1",
            },
        },
    },
    replication_config={
        "state": aws_native.events.EndpointReplicationState.DISABLED,
    },
    event_buses=[
        {
            "event_bus_arn": "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
        },
        {
            "event_bus_arn": "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
        },
    ])
pulumi.export("sampleEndpointName", sample_endpoint.id)

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleEndpoint = new aws_native.events.Endpoint("sampleEndpoint", {
    name: "CreateExampleEndpoint",
    routingConfig: {
        failoverConfig: {
            primary: {
                healthCheck: "arn:aws:route53:::healthcheck/0123456789abc",
            },
            secondary: {
                route: "us-east-1",
            },
        },
    },
    replicationConfig: {
        state: aws_native.events.EndpointReplicationState.Disabled,
    },
    eventBuses: [
        {
            eventBusArn: "arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
        },
        {
            eventBusArn: "arn:aws:events:us-east-1:123456789012:event-bus/ExampleEventBus",
        },
    ],
});
export const sampleEndpointName = sampleEndpoint.id;

Coming soon!

Create Endpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             event_buses: Optional[Sequence[EndpointEventBusArgs]] = None,
             routing_config: Optional[EndpointRoutingConfigArgs] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             replication_config: Optional[EndpointReplicationConfigArgs] = None,
             role_arn: Optional[str] = None)

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: aws-native:events:Endpoint
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 EndpointArgs: 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 EndpointArgs: 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 EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Endpoint 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 Endpoint resource accepts the following input properties:

EventBuses List<Pulumi.AwsNative.Events.Inputs.EndpointEventBus>

The event buses being used by the endpoint.

Exactly : 2

RoutingConfig Pulumi.AwsNative.Events.Inputs.EndpointRoutingConfig

The routing configuration of the endpoint.

Description string

A description for the endpoint.

Name string

The name of the endpoint.

ReplicationConfig Pulumi.AwsNative.Events.Inputs.EndpointReplicationConfig

Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn . If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED .

RoleArn string

The ARN of the role used by event replication for the endpoint.

EventBuses []EndpointEventBusArgs

The event buses being used by the endpoint.

Exactly : 2

RoutingConfig EndpointRoutingConfigArgs

The routing configuration of the endpoint.

Description string

A description for the endpoint.

Name string

The name of the endpoint.

ReplicationConfig EndpointReplicationConfigArgs

RoleArn string

The ARN of the role used by event replication for the endpoint.

eventBuses List<EndpointEventBus>

The event buses being used by the endpoint.

Exactly : 2

routingConfig EndpointRoutingConfig

The routing configuration of the endpoint.

description String

A description for the endpoint.

name String

The name of the endpoint.

replicationConfig EndpointReplicationConfig

roleArn String

The ARN of the role used by event replication for the endpoint.

eventBuses EndpointEventBus[]

The event buses being used by the endpoint.

Exactly : 2

routingConfig EndpointRoutingConfig

The routing configuration of the endpoint.

description string

A description for the endpoint.

name string

The name of the endpoint.

replicationConfig EndpointReplicationConfig

roleArn string

The ARN of the role used by event replication for the endpoint.

event_buses Sequence[EndpointEventBusArgs]

The event buses being used by the endpoint.

Exactly : 2

routing_config EndpointRoutingConfigArgs

The routing configuration of the endpoint.

description str

A description for the endpoint.

name str

The name of the endpoint.

replication_config EndpointReplicationConfigArgs

role_arn str

The ARN of the role used by event replication for the endpoint.

eventBuses List<Property Map>

The event buses being used by the endpoint.

Exactly : 2

routingConfig Property Map

The routing configuration of the endpoint.

description String

A description for the endpoint.

name String

The name of the endpoint.

replicationConfig Property Map

roleArn String

The ARN of the role used by event replication for the endpoint.

Outputs

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

Arn string: The ARN of the endpoint.
EndpointId string: The ID of the endpoint.
EndpointUrl string: The URL of the endpoint.
Id string: The provider-assigned unique ID for this managed resource.
State Pulumi.AwsNative.Events.EndpointState: The main Region of the endpoint.
StateReason string: The reason the endpoint is in its current state.

Arn string: The ARN of the endpoint.
EndpointId string: The ID of the endpoint.
EndpointUrl string: The URL of the endpoint.
Id string: The provider-assigned unique ID for this managed resource.
State EndpointStateEnum: The main Region of the endpoint.
StateReason string: The reason the endpoint is in its current state.

arn String: The ARN of the endpoint.
endpointId String: The ID of the endpoint.
endpointUrl String: The URL of the endpoint.
id String: The provider-assigned unique ID for this managed resource.
state EndpointState: The main Region of the endpoint.
stateReason String: The reason the endpoint is in its current state.

arn string: The ARN of the endpoint.
endpointId string: The ID of the endpoint.
endpointUrl string: The URL of the endpoint.
id string: The provider-assigned unique ID for this managed resource.
state EndpointState: The main Region of the endpoint.
stateReason string: The reason the endpoint is in its current state.

arn str: The ARN of the endpoint.
endpoint_id str: The ID of the endpoint.
endpoint_url str: The URL of the endpoint.
id str: The provider-assigned unique ID for this managed resource.
state EndpointState: The main Region of the endpoint.
state_reason str: The reason the endpoint is in its current state.

arn String: The ARN of the endpoint.
endpointId String: The ID of the endpoint.
endpointUrl String: The URL of the endpoint.
id String: The provider-assigned unique ID for this managed resource.
state "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "CREATE_FAILED" | "UPDATE_FAILED": The main Region of the endpoint.
stateReason String: The reason the endpoint is in its current state.

Supporting Types

EndpointEventBus, EndpointEventBusArgs

EventBusArn string

EventBusArn string

eventBusArn String

eventBusArn string

event_bus_arn str

eventBusArn String

EndpointFailoverConfig, EndpointFailoverConfigArgs

Primary Pulumi.AwsNative.Events.Inputs.EndpointPrimary: The main Region of the endpoint.
Secondary Pulumi.AwsNative.Events.Inputs.EndpointSecondary: The Region that events are routed to when failover is triggered or event replication is enabled.

Primary EndpointPrimary: The main Region of the endpoint.
Secondary EndpointSecondary: The Region that events are routed to when failover is triggered or event replication is enabled.

primary EndpointPrimary: The main Region of the endpoint.
secondary EndpointSecondary: The Region that events are routed to when failover is triggered or event replication is enabled.

primary EndpointPrimary: The main Region of the endpoint.
secondary EndpointSecondary: The Region that events are routed to when failover is triggered or event replication is enabled.

primary EndpointPrimary: The main Region of the endpoint.
secondary EndpointSecondary: The Region that events are routed to when failover is triggered or event replication is enabled.

primary Property Map: The main Region of the endpoint.
secondary Property Map: The Region that events are routed to when failover is triggered or event replication is enabled.

EndpointPrimary, EndpointPrimaryArgs

HealthCheck string: The ARN of the health check used by the endpoint to determine whether failover is triggered.

HealthCheck string: The ARN of the health check used by the endpoint to determine whether failover is triggered.

healthCheck String: The ARN of the health check used by the endpoint to determine whether failover is triggered.

healthCheck string: The ARN of the health check used by the endpoint to determine whether failover is triggered.

health_check str: The ARN of the health check used by the endpoint to determine whether failover is triggered.

healthCheck String: The ARN of the health check used by the endpoint to determine whether failover is triggered.

EndpointReplicationConfig, EndpointReplicationConfigArgs

State Pulumi.AwsNative.Events.EndpointReplicationState: The state of event replication.

State EndpointReplicationState: The state of event replication.

state EndpointReplicationState: The state of event replication.

state EndpointReplicationState: The state of event replication.

state EndpointReplicationState: The state of event replication.

state "ENABLED" | "DISABLED": The state of event replication.

EndpointReplicationState, EndpointReplicationStateArgs

Enabled: ENABLED
Disabled: DISABLED

EndpointReplicationStateEnabled: ENABLED
EndpointReplicationStateDisabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

ENABLED: ENABLED
DISABLED: DISABLED

"ENABLED": ENABLED
"DISABLED": DISABLED

EndpointRoutingConfig, EndpointRoutingConfigArgs

FailoverConfig Pulumi.AwsNative.Events.Inputs.EndpointFailoverConfig: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

FailoverConfig EndpointFailoverConfig: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

failoverConfig EndpointFailoverConfig: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

failoverConfig EndpointFailoverConfig: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

failover_config EndpointFailoverConfig: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

failoverConfig Property Map: The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

EndpointSecondary, EndpointSecondaryArgs

Route string: Defines the secondary Region.

Route string: Defines the secondary Region.

route String: Defines the secondary Region.

route string: Defines the secondary Region.

route str: Defines the secondary Region.

route String: Defines the secondary Region.

EndpointState, EndpointStateArgs

Active: ACTIVE
Creating: CREATING
Updating: UPDATING
Deleting: DELETING
CreateFailed: CREATE_FAILED
UpdateFailed: UPDATE_FAILED

EndpointStateActive: ACTIVE
EndpointStateCreating: CREATING
EndpointStateUpdating: UPDATING
EndpointStateDeleting: DELETING
EndpointStateCreateFailed: CREATE_FAILED
EndpointStateUpdateFailed: UPDATE_FAILED

Active: ACTIVE
Creating: CREATING
Updating: UPDATING
Deleting: DELETING
CreateFailed: CREATE_FAILED
UpdateFailed: UPDATE_FAILED

Active: ACTIVE
Creating: CREATING
Updating: UPDATING
Deleting: DELETING
CreateFailed: CREATE_FAILED
UpdateFailed: UPDATE_FAILED

ACTIVE: ACTIVE
CREATING: CREATING
UPDATING: UPDATING
DELETING: DELETING
CREATE_FAILED: CREATE_FAILED
UPDATE_FAILED: UPDATE_FAILED

"ACTIVE": ACTIVE
"CREATING": CREATING
"UPDATING": UPDATING
"DELETING": DELETING
"CREATE_FAILED": CREATE_FAILED
"UPDATE_FAILED": UPDATE_FAILED

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.events.Endpoint

On this page

On this page

Example Usage

Example

Example

Create Endpoint Resource

Constructor syntax

Parameters

Endpoint Resource Properties

Inputs

Outputs

Supporting Types

EndpointEventBus, EndpointEventBusArgs

EndpointFailoverConfig, EndpointFailoverConfigArgs

EndpointPrimary, EndpointPrimaryArgs

EndpointReplicationConfig, EndpointReplicationConfigArgs

EndpointReplicationState, EndpointReplicationStateArgs

EndpointRoutingConfig, EndpointRoutingConfigArgs

EndpointSecondary, EndpointSecondaryArgs

EndpointState, EndpointStateArgs

Package Details

On this page

On this page