Package software.amazon.awscdk.services.events

Interface CfnEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.977Z")
@Stability(Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.*;
 CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder()
         .eventBuses(List.of(EndpointEventBusProperty.builder()
                 .eventBusArn("eventBusArn")
                 .build()))
         .routingConfig(RoutingConfigProperty.builder()
                 .failoverConfig(FailoverConfigProperty.builder()
                         .primary(PrimaryProperty.builder()
                                 .healthCheck("healthCheck")
                                 .build())
                         .secondary(SecondaryProperty.builder()
                                 .route("route")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .name("name")
         .replicationConfig(ReplicationConfigProperty.builder()
                 .state("state")
                 .build())
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointProps.Builder	A builder for CfnEndpointProps
static final class	CfnEndpointProps.Jsii$Proxy	An implementation for CfnEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnEndpointProps.Builder	builder()
default String	getDescription()	A description for the endpoint.
Object	getEventBuses()	The event buses being used by the endpoint.
default String	getName()	The name of the endpoint.
default Object	getReplicationConfig()	Whether event replication was enabled or disabled for this endpoint.
default String	getRoleArn()	The ARN of the role used by event replication for the endpoint.
Object	getRoutingConfig()	The routing configuration of the endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventBuses

@Stability(Stable)
@NotNull
Object getEventBuses()

The event buses being used by the endpoint.

Exactly : 2

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-eventbuses

getRoutingConfig

@Stability(Stable)
@NotNull
Object getRoutingConfig()

The routing configuration of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-routingconfig

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-name

getReplicationConfig

@Stability(Stable)
@Nullable
default Object getReplicationConfig()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-replicationconfig

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-endpoint.html#cfn-events-endpoint-rolearn

builder

@Stability(Stable)
static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps