Package software.amazon.awscdk.cfnpropertymixins.services.transfer

Class CfnServerPropsMixin.EndpointDetailsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnServerPropsMixin.EndpointDetailsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnServerPropsMixin.EndpointDetailsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnServerPropsMixin.EndpointDetailsProperty

@Stability(Stable)
@Internal
public static final class CfnServerPropsMixin.EndpointDetailsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnServerPropsMixin.EndpointDetailsProperty

An implementation for CfnServerPropsMixin.EndpointDetailsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.transfer.CfnServerPropsMixin.EndpointDetailsProperty

CfnServerPropsMixin.EndpointDetailsProperty.Builder, CfnServerPropsMixin.EndpointDetailsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnServerPropsMixin.EndpointDetailsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnServerPropsMixin.EndpointDetailsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAddressAllocationIds()	A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
final List<String>	getSecurityGroupIds()	A list of security groups IDs that are available to attach to your server's endpoint.
final List<String>	getSubnetIds()	A list of subnet IDs that are required to host your server endpoint in your VPC.
final String	getVpcEndpointId()	The ID of the VPC endpoint.
final String	getVpcId()	The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnServerPropsMixin.EndpointDetailsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnServerPropsMixin.EndpointDetailsProperty.Builder.

Method Details

getAddressAllocationIds

public final List<String> getAddressAllocationIds()

Description copied from interface: CfnServerPropsMixin.EndpointDetailsProperty

A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.

An address allocation ID corresponds to the allocation ID of an Elastic IP address. This value can be retrieved from the allocationId field from the Amazon EC2 Address data type. One way to retrieve this value is by calling the EC2 DescribeAddresses API.

This parameter is optional. Set this parameter if you want to make your VPC endpoint public-facing. For details, see Create an internet-facing endpoint for your server .

This property can only be set as follows:

• EndpointType must be set to VPC
• The Transfer Family server must be offline.
• You cannot set this parameter for Transfer Family servers that use the FTP protocol.
• The server must already have SubnetIds populated ( SubnetIds and AddressAllocationIds cannot be updated simultaneously).
• AddressAllocationIds can't contain duplicates, and must be equal in length to SubnetIds . For example, if you have three subnet IDs, you must also specify three address allocation IDs.
• Call the UpdateServer API to set or change this parameter.
• You can't set address allocation IDs for servers that have an IpAddressType set to DUALSTACK You can only set this property if IpAddressType is set to IPV4 .

Specified by:

getAddressAllocationIds in interface CfnServerPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-addressallocationids

getSecurityGroupIds

public final List<String> getSecurityGroupIds()

Description copied from interface: CfnServerPropsMixin.EndpointDetailsProperty

A list of security groups IDs that are available to attach to your server's endpoint.

While SecurityGroupIds appears in the response syntax for consistency with CreateServer and UpdateServer operations, this field is not populated in DescribeServer responses. Security groups are managed at the VPC endpoint level and can be modified outside of the Transfer Family service. To retrieve current security group information, use the EC2 DescribeVpcEndpoints API with the VpcEndpointId returned in the response.

This property can only be set when EndpointType is set to VPC .

You can edit the SecurityGroupIds property in the UpdateServer API only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC . To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.

Specified by:

getSecurityGroupIds in interface CfnServerPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-securitygroupids

getSubnetIds

public final List<String> getSubnetIds()

Description copied from interface: CfnServerPropsMixin.EndpointDetailsProperty

A list of subnet IDs that are required to host your server endpoint in your VPC.

This property can only be set when EndpointType is set to VPC .

Specified by:

getSubnetIds in interface CfnServerPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-subnetids

getVpcEndpointId

public final String getVpcEndpointId()

Description copied from interface: CfnServerPropsMixin.EndpointDetailsProperty

The ID of the VPC endpoint.

This property can only be set when EndpointType is set to VPC_ENDPOINT .

Specified by:

getVpcEndpointId in interface CfnServerPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcendpointid

getVpcId

public final String getVpcId()

Description copied from interface: CfnServerPropsMixin.EndpointDetailsProperty

The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.

This property can only be set when EndpointType is set to VPC .

Specified by:

getVpcId in interface CfnServerPropsMixin.EndpointDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-server-endpointdetails.html#cfn-transfer-server-endpointdetails-vpcid

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object