Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. events
  5. getEndpoint

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.getEndpoint

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

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

    Using getEndpoint

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

    > Note: This function is named LookupEndpoint in the Go SDK.

    public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:events:getEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the endpoint.
    Name string
    The name of the endpoint.
    name String
    The name of the endpoint.
    name string
    The name of the endpoint.
    name str
    The name of the endpoint.
    name String
    The name of the endpoint.

    getEndpoint Result

    The following output properties are available:

    Arn string
    The ARN of the endpoint.
    Description string
    A description for the endpoint.
    EndpointId string
    The ID of the endpoint.
    EndpointUrl string
    The URL of the endpoint.
    EventBuses List<Pulumi.AwsNative.Events.Outputs.EndpointEventBus>

    The event buses being used by the endpoint.

    Exactly : 2

    ReplicationConfig Pulumi.AwsNative.Events.Outputs.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.
    RoutingConfig Pulumi.AwsNative.Events.Outputs.EndpointRoutingConfig
    The routing configuration of the endpoint.
    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.
    Description string
    A description for the endpoint.
    EndpointId string
    The ID of the endpoint.
    EndpointUrl string
    The URL of the endpoint.
    EventBuses []EndpointEventBus

    The event buses being used by the endpoint.

    Exactly : 2

    ReplicationConfig 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.
    RoutingConfig EndpointRoutingConfig
    The routing configuration of the endpoint.
    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.
    description String
    A description for the endpoint.
    endpointId String
    The ID of the endpoint.
    endpointUrl String
    The URL of the endpoint.
    eventBuses List<EndpointEventBus>

    The event buses being used by the endpoint.

    Exactly : 2

    replicationConfig 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.
    routingConfig EndpointRoutingConfig
    The routing configuration of the endpoint.
    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.
    description string
    A description for the endpoint.
    endpointId string
    The ID of the endpoint.
    endpointUrl string
    The URL of the endpoint.
    eventBuses EndpointEventBus[]

    The event buses being used by the endpoint.

    Exactly : 2

    replicationConfig 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.
    routingConfig EndpointRoutingConfig
    The routing configuration of the endpoint.
    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.
    description str
    A description for the endpoint.
    endpoint_id str
    The ID of the endpoint.
    endpoint_url str
    The URL of the endpoint.
    event_buses Sequence[EndpointEventBus]

    The event buses being used by the endpoint.

    Exactly : 2

    replication_config 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 .
    role_arn str
    The ARN of the role used by event replication for the endpoint.
    routing_config EndpointRoutingConfig
    The routing configuration of the endpoint.
    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.
    description String
    A description for the endpoint.
    endpointId String
    The ID of the endpoint.
    endpointUrl String
    The URL of the endpoint.
    eventBuses List<Property Map>

    The event buses being used by the endpoint.

    Exactly : 2

    replicationConfig Property Map
    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.
    routingConfig Property Map
    The routing configuration of the endpoint.
    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

    EndpointFailoverConfig

    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

    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

    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

    EndpointRoutingConfig

    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

    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

    Package Details

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

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native