Interface CfnEndpointProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:17.011Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEndpointProps
static final class
An implementation forCfnEndpointProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnEndpointProps.Builder
builder()
default String
A description for the endpoint.The event buses being used by the endpoint.default String
getName()
The name of the endpoint.default Object
Whether event replication was enabled or disabled for this endpoint.default String
The ARN of the role used by event replication for the endpoint.The routing configuration of the endpoint.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEventBuses
The event buses being used by the endpoint.Exactly :
2
- See Also:
-
getRoutingConfig
The routing configuration of the endpoint.- See Also:
-
getDescription
A description for the endpoint.- See Also:
-
getName
The name of the endpoint.- See Also:
-
getReplicationConfig
Whether event replication was enabled or disabled for this endpoint.The default state is
ENABLED
which means you must supply aRoleArn
. If you don't have aRoleArn
or you don't want event replication enabled, set the state toDISABLED
.- See Also:
-
getRoleArn
The ARN of the role used by event replication for the endpoint.- See Also:
-
builder
- Returns:
- a
CfnEndpointProps.Builder
ofCfnEndpointProps
-