1. Packages
  2. AWS Native
  3. API Docs
  4. events
  5. Endpoint

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.events.Endpoint

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::Events::Endpoint.

    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=aws_native.events.EndpointRoutingConfigArgs(
            failover_config=aws_native.events.EndpointFailoverConfigArgs(
                primary=aws_native.events.EndpointPrimaryArgs(
                    health_check="arn:aws:route53:::healthcheck/0123456789abc",
                ),
                secondary=aws_native.events.EndpointSecondaryArgs(
                    route="us-east-1",
                ),
            ),
        ),
        replication_config=aws_native.events.EndpointReplicationConfigArgs(
            state=aws_native.events.EndpointReplicationState.ENABLED,
        ),
        role_arn="arn:aws:iam::123456789012:role/EndpointReplicationRole",
        event_buses=[
            aws_native.events.EndpointEventBusArgs(
                event_bus_arn="arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
            ),
            aws_native.events.EndpointEventBusArgs(
                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=aws_native.events.EndpointRoutingConfigArgs(
            failover_config=aws_native.events.EndpointFailoverConfigArgs(
                primary=aws_native.events.EndpointPrimaryArgs(
                    health_check="arn:aws:route53:::healthcheck/0123456789abc",
                ),
                secondary=aws_native.events.EndpointSecondaryArgs(
                    route="us-east-1",
                ),
            ),
        ),
        replication_config=aws_native.events.EndpointReplicationConfigArgs(
            state=aws_native.events.EndpointReplicationState.DISABLED,
        ),
        event_buses=[
            aws_native.events.EndpointEventBusArgs(
                event_bus_arn="arn:aws:events:us-west-2:123456789012:event-bus/ExampleEventBus",
            ),
            aws_native.events.EndpointEventBusArgs(
                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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const endpointResource = new aws_native.events.Endpoint("endpointResource", {
        eventBuses: [{
            eventBusArn: "string",
        }],
        routingConfig: {
            failoverConfig: {
                primary: {
                    healthCheck: "string",
                },
                secondary: {
                    route: "string",
                },
            },
        },
        description: "string",
        name: "string",
        replicationConfig: {
            state: aws_native.events.EndpointReplicationState.Enabled,
        },
        roleArn: "string",
    });
    
    Coming soon!
    

    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

    The Endpoint resource accepts the following input properties:

    Outputs

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

    Arn string
    EndpointId string
    EndpointUrl string
    Id string
    The provider-assigned unique ID for this managed resource.
    State Pulumi.AwsNative.Events.EndpointState
    StateReason string
    Arn string
    EndpointId string
    EndpointUrl string
    Id string
    The provider-assigned unique ID for this managed resource.
    State EndpointStateEnum
    StateReason string
    arn String
    endpointId String
    endpointUrl String
    id String
    The provider-assigned unique ID for this managed resource.
    state EndpointState
    stateReason String
    arn string
    endpointId string
    endpointUrl string
    id string
    The provider-assigned unique ID for this managed resource.
    state EndpointState
    stateReason string
    arn str
    endpoint_id str
    endpoint_url str
    id str
    The provider-assigned unique ID for this managed resource.
    state EndpointState
    state_reason str
    arn String
    endpointId String
    endpointUrl String
    id String
    The provider-assigned unique ID for this managed resource.
    state "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "CREATE_FAILED" | "UPDATE_FAILED"
    stateReason String

    Supporting Types

    EndpointEventBus, EndpointEventBusArgs

    EndpointFailoverConfig, EndpointFailoverConfigArgs

    EndpointPrimary, EndpointPrimaryArgs

    EndpointReplicationConfig, EndpointReplicationConfigArgs

    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

    EndpointSecondary, EndpointSecondaryArgs

    Route string
    Route string
    route String
    route string
    route str
    route String

    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi