Package software.amazon.awscdk.services.globalaccelerator

Class CfnEndpointGroup.EndpointConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.CfnEndpointGroup.EndpointConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointGroup.EndpointConfigurationProperty>

Enclosing interface:

CfnEndpointGroup.EndpointConfigurationProperty

@Stability(Stable)
public static final class CfnEndpointGroup.EndpointConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpointGroup.EndpointConfigurationProperty>

A builder for CfnEndpointGroup.EndpointConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointGroup.EndpointConfigurationProperty.Builder	attachmentArn(String attachmentArn)	Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getAttachmentArn()
CfnEndpointGroup.EndpointConfigurationProperty	build()	Builds the configured instance.
CfnEndpointGroup.EndpointConfigurationProperty.Builder	clientIpPreservationEnabled(Boolean clientIpPreservationEnabled)	Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getClientIpPreservationEnabled()
CfnEndpointGroup.EndpointConfigurationProperty.Builder	clientIpPreservationEnabled(IResolvable clientIpPreservationEnabled)	Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getClientIpPreservationEnabled()
CfnEndpointGroup.EndpointConfigurationProperty.Builder	endpointId(String endpointId)	Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getEndpointId()
CfnEndpointGroup.EndpointConfigurationProperty.Builder	weight(Number weight)	Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getWeight()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

endpointId

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty.Builder endpointId(String endpointId)

Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getEndpointId()

Parameters:

endpointId - An ID for the endpoint. This parameter is required. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.

For cross-account endpoints, this must be the ARN of the resource.

Returns:

this

attachmentArn

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty.Builder attachmentArn(String attachmentArn)

Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getAttachmentArn()

Parameters:

attachmentArn - The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.

Returns:

this

clientIpPreservationEnabled

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty.Builder clientIpPreservationEnabled(Boolean clientIpPreservationEnabled)

Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getClientIpPreservationEnabled()

Parameters:

clientIpPreservationEnabled - Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide .

Returns:

this

clientIpPreservationEnabled

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty.Builder clientIpPreservationEnabled(IResolvable clientIpPreservationEnabled)

Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getClientIpPreservationEnabled()

Parameters:

clientIpPreservationEnabled - Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Preserve Client IP Addresses in the AWS Global Accelerator Developer Guide .

Returns:

this

weight

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty.Builder weight(Number weight)

Sets the value of CfnEndpointGroup.EndpointConfigurationProperty.getWeight()

Parameters:

weight - The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide .

Returns:

this

build

@Stability(Stable)
public CfnEndpointGroup.EndpointConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpointGroup.EndpointConfigurationProperty>

Returns:

a new instance of CfnEndpointGroup.EndpointConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided