Class CfnServer.EndpointDetailsProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnServer.EndpointDetailsProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnServer.EndpointDetailsProperty
CfnServer.EndpointDetailsProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.transfer.CfnServer.EndpointDetailsProperty
CfnServer.EndpointDetailsProperty.Builder, CfnServer.EndpointDetailsProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnServer.EndpointDetailsProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanA list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.A list of security groups IDs that are available to attach to your server's endpoint.A list of subnet IDs that are required to host your server endpoint in your VPC.final StringThe ID of the VPC endpoint.final StringgetVpcId()The VPC ID of the virtual private cloud in which the server's endpoint will be hosted.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theCfnServer.EndpointDetailsProperty.Builder.
-
-
Method Details
-
getAddressAllocationIds
Description copied from interface:CfnServer.EndpointDetailsPropertyA 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
allocationIdfield 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:
EndpointTypemust be set toVPC- 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
SubnetIdspopulated (SubnetIdsandAddressAllocationIdscannot be updated simultaneously). AddressAllocationIdscan't contain duplicates, and must be equal in length toSubnetIds. For example, if you have three subnet IDs, you must also specify three address allocation IDs.- Call the
UpdateServerAPI to set or change this parameter. - You can't set address allocation IDs for servers that have an
IpAddressTypeset toDUALSTACKYou can only set this property ifIpAddressTypeis set toIPV4.
- Specified by:
getAddressAllocationIdsin interfaceCfnServer.EndpointDetailsProperty- See Also:
-
getSecurityGroupIds
Description copied from interface:CfnServer.EndpointDetailsPropertyA list of security groups IDs that are available to attach to your server's endpoint.While
SecurityGroupIdsappears in the response syntax for consistency withCreateServerandUpdateServeroperations, this field is not populated inDescribeServerresponses. 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 EC2DescribeVpcEndpointsAPI with theVpcEndpointIdreturned in the response.This property can only be set when
EndpointTypeis set toVPC.You can edit the
SecurityGroupIdsproperty in the UpdateServer API only if you are changing theEndpointTypefromPUBLICorVPC_ENDPOINTtoVPC. To change security groups associated with your server's VPC endpoint after creation, use the Amazon EC2 ModifyVpcEndpoint API.- Specified by:
getSecurityGroupIdsin interfaceCfnServer.EndpointDetailsProperty- See Also:
-
getSubnetIds
Description copied from interface:CfnServer.EndpointDetailsPropertyA list of subnet IDs that are required to host your server endpoint in your VPC.This property can only be set when
EndpointTypeis set toVPC.- Specified by:
getSubnetIdsin interfaceCfnServer.EndpointDetailsProperty- See Also:
-
getVpcEndpointId
Description copied from interface:CfnServer.EndpointDetailsPropertyThe ID of the VPC endpoint.This property can only be set when
EndpointTypeis set toVPC_ENDPOINT.- Specified by:
getVpcEndpointIdin interfaceCfnServer.EndpointDetailsProperty- See Also:
-
getVpcId
Description copied from interface:CfnServer.EndpointDetailsPropertyThe VPC ID of the virtual private cloud in which the server's endpoint will be hosted.This property can only be set when
EndpointTypeis set toVPC.- Specified by:
getVpcIdin interfaceCfnServer.EndpointDetailsProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-