AWS AWSCloudFormation documentation change
Summary
Added IpAddressType property documentation and removed examples/see also section
Security assessment
Added documentation for IpAddressType (IPv4/dual-stack) with configuration constraints. While this relates to network security configurations, there is no evidence of addressing a specific vulnerability. The change adds documentation about network configuration options that could influence security posture.
Diff
diff --git a/AWSCloudFormation/latest/TemplateReference/aws-resource-transfer-server.md b/AWSCloudFormation/latest/TemplateReference/aws-resource-transfer-server.md index 17d060140..c3bda8293 100644 --- a//AWSCloudFormation/latest/TemplateReference/aws-resource-transfer-server.md +++ b//AWSCloudFormation/latest/TemplateReference/aws-resource-transfer-server.md @@ -3 +3 @@ -SyntaxPropertiesReturn valuesExamplesSee also +SyntaxPropertiesReturn values @@ -26,0 +27 @@ To declare this entity in your AWS CloudFormation template, use the following sy + "IpAddressType" : String, @@ -53,0 +55 @@ To declare this entity in your AWS CloudFormation template, use the following sy + IpAddressType: String @@ -188,0 +191,28 @@ _Required_ : No +`IpAddressType` + + +Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint. The default value is `IPV4`. + +###### Important + +The `IpAddressType` parameter has the following limitations: + + * It cannot be changed while the server is online. You must stop the server before modifying this parameter. + + * It cannot be updated to `DUALSTACK` if the server has `AddressAllocationIds` specified. + + + + +###### Note + +When using `DUALSTACK` as the `IpAddressType`, you cannot set the `AddressAllocationIds` parameter for the [EndpointDetails](https://docs.aws.amazon.com/transfer/latest/APIReference/API_EndpointDetails.html) for the server. + +_Required_ : No + + _Type_ : String + + _Allowed values_ : `IPV4 | DUALSTACK` + + _Update requires_ : [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt) + @@ -447,83 +476,0 @@ The states of `STARTING` and `STOPPING` indicate that the server is in an interm -## Examples - -### Create a server with VPC hosted endpoint type - -The following example creates a Secure Shell (SSH) File Transfer Protocol (SFTP)-enabled server using a VPC hosted endpoint type with a custom identity provider, a CloudWatch logging role, security policy, and tags. - -#### JSON - - - { - "AWSTemplateFormatVersion": "2010-09-09", - "Description": "creates SFTP Server", - "Resources": { - "MyTransferServer": { - "Type": "AWS::Transfer::Server", - "Properties": { - "EndpointDetails": { - "AddressAllocationIds": [ - "AddressAllocationId-1", - "AddressAllocationId-2" - ], - "SubnetIds": [ - "SubnetId-1", - "SubnetId-2" - ], - "VpcId": "VpcId" - }, - "EndpointType": "VPC", - "LoggingRole": "Logging-Role-ARN", - "Protocols": [ - "SFTP" - ], - "SecurityPolicyName": "Security-Policy-Name", - "IdentityProviderDetails": { - "InvocationRole": "Invocation-Role-ARN", - "Url": "API_GATEWAY-Invocation-URL" - }, - "IdentityProviderType": "API_GATEWAY", - "Tags": [ - { - "Key": "KeyName", - "Value": "ValueName" - } - ] - } - } - } - } - -#### YAML - - - AWSTemplateFormatVersion: '2010-09-09' - Description: creates SFTP Server - Resources: - MyTransferServer: - Type : AWS::Transfer::Server - Properties : - EndpointDetails: - AddressAllocationIds: - - AddressAllocationId-1 - - AddressAllocationId-2 - SubnetIds: - - SubnetId-1 - - SubnetId-2 - VpcId: VpcId - EndpointType: VPC - LoggingRole: Logging-Role-ARN - Protocols: - - SFTP - SecurityPolicyName: Security-Policy-Name - IdentityProviderDetails: - InvocationRole: Invocation-Role-ARN - Url: API_GATEWAY-Invocation-URL - IdentityProviderType: API_GATEWAY - Tags: - - Key: KeyName - Value: ValueName - -## See also - -[CreateServer](https://docs.aws.amazon.com/transfer/latest/userguide/API_CreateServer.html) in the _AWS Transfer Family User Guide_. -