Skip to content

Commit a12cf06

Browse files
author
awstools
committed
feat(client-transfer): Add ability to specify Security Policies for SFTP Connectors
1 parent 46ea196 commit a12cf06

File tree

8 files changed

+215
-35
lines changed

8 files changed

+215
-35
lines changed

Diff for: clients/client-transfer/src/commands/CreateConnectorCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
6666
* "STRING_VALUE",
6767
* ],
6868
* },
69+
* SecurityPolicyName: "STRING_VALUE",
6970
* };
7071
* const command = new CreateConnectorCommand(input);
7172
* const response = await client.send(command);

Diff for: clients/client-transfer/src/commands/DescribeConnectorCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
7373
* // ServiceManagedEgressIpAddresses: [ // ServiceManagedEgressIpAddresses
7474
* // "STRING_VALUE",
7575
* // ],
76+
* // SecurityPolicyName: "STRING_VALUE",
7677
* // },
7778
* // };
7879
*

Diff for: clients/client-transfer/src/commands/DescribeSecurityPolicyCommand.ts

+10-3
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ export interface DescribeSecurityPolicyCommandInput extends DescribeSecurityPoli
2727
export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPolicyResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Describes the security policy that is attached to your file transfer protocol-enabled
31-
* server. The response contains a description of the security policy's properties. For more
30+
* <p>Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more
3231
* information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
33-
* policies</a>.</p>
32+
* policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
33+
* policies for SFTP connectors</a>.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript
@@ -58,6 +58,13 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol
5858
* // TlsCiphers: [
5959
* // "STRING_VALUE",
6060
* // ],
61+
* // SshHostKeyAlgorithms: [
62+
* // "STRING_VALUE",
63+
* // ],
64+
* // Type: "SERVER" || "CONNECTOR",
65+
* // Protocols: [ // SecurityPolicyProtocols
66+
* // "SFTP" || "FTPS",
67+
* // ],
6168
* // },
6269
* // };
6370
*

Diff for: clients/client-transfer/src/commands/ListSecurityPoliciesCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ export interface ListSecurityPoliciesCommandInput extends ListSecurityPoliciesRe
2727
export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Lists the security policies that are attached to your file transfer protocol-enabled
31-
* servers.</p>
30+
* <p>Lists the security policies that are attached to your servers and SFTP connectors. For more information
31+
* about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
32+
* policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
33+
* policies for SFTP connectors</a>.</p>
3234
* @example
3335
* Use a bare-bones client and the command you need to make an API call.
3436
* ```javascript

Diff for: clients/client-transfer/src/commands/UpdateConnectorCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
5858
* "STRING_VALUE",
5959
* ],
6060
* },
61+
* SecurityPolicyName: "STRING_VALUE",
6162
* };
6263
* const command = new UpdateConnectorCommand(input);
6364
* const response = await client.send(command);

Diff for: clients/client-transfer/src/models/models_0.ts

+90-16
Original file line numberDiff line numberDiff line change
@@ -1057,6 +1057,12 @@ export interface CreateConnectorRequest {
10571057
* @public
10581058
*/
10591059
SftpConfig?: SftpConnectorConfig;
1060+
1061+
/**
1062+
* <p>Specifies the name of the security policy for the connector.</p>
1063+
* @public
1064+
*/
1065+
SecurityPolicyName?: string;
10601066
}
10611067

10621068
/**
@@ -1827,7 +1833,7 @@ export interface CreateServerRequest {
18271833
ProtocolDetails?: ProtocolDetails;
18281834

18291835
/**
1830-
* <p>Specifies the name of the security policy that is attached to the server.</p>
1836+
* <p>Specifies the name of the security policy for the server.</p>
18311837
* @public
18321838
*/
18331839
SecurityPolicyName?: string;
@@ -3116,6 +3122,12 @@ export interface DescribedConnector {
31163122
* @public
31173123
*/
31183124
ServiceManagedEgressIpAddresses?: string[];
3125+
3126+
/**
3127+
* <p>The text name of the security policy for the specified connector.</p>
3128+
* @public
3129+
*/
3130+
SecurityPolicyName?: string;
31193131
}
31203132

31213133
/**
@@ -3590,52 +3602,108 @@ export interface DescribedProfile {
35903602
}
35913603

35923604
/**
3593-
* <p>Describes the properties of a security policy that was specified. For more information
3605+
* @public
3606+
* @enum
3607+
*/
3608+
export const SecurityPolicyProtocol = {
3609+
FTPS: "FTPS",
3610+
SFTP: "SFTP",
3611+
} as const;
3612+
3613+
/**
3614+
* @public
3615+
*/
3616+
export type SecurityPolicyProtocol = (typeof SecurityPolicyProtocol)[keyof typeof SecurityPolicyProtocol];
3617+
3618+
/**
3619+
* @public
3620+
* @enum
3621+
*/
3622+
export const SecurityPolicyResourceType = {
3623+
CONNECTOR: "CONNECTOR",
3624+
SERVER: "SERVER",
3625+
} as const;
3626+
3627+
/**
3628+
* @public
3629+
*/
3630+
export type SecurityPolicyResourceType = (typeof SecurityPolicyResourceType)[keyof typeof SecurityPolicyResourceType];
3631+
3632+
/**
3633+
* <p>Describes the properties of a security policy that you specify. For more information
35943634
* about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security
3595-
* policies</a>.</p>
3635+
* policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security
3636+
* policies for SFTP connectors</a>.</p>
35963637
* @public
35973638
*/
35983639
export interface DescribedSecurityPolicy {
35993640
/**
3600-
* <p>Specifies whether this policy enables Federal Information Processing Standards
3601-
* (FIPS).</p>
3641+
* <p>Specifies whether this policy enables Federal Information Processing Standards (FIPS).
3642+
* This parameter applies to both server and connector security policies.</p>
36023643
* @public
36033644
*/
36043645
Fips?: boolean;
36053646

36063647
/**
3607-
* <p>Specifies the name of the security policy that is attached to the server.</p>
3648+
* <p>The text name of the specified security policy.</p>
36083649
* @public
36093650
*/
36103651
SecurityPolicyName: string | undefined;
36113652

36123653
/**
3613-
* <p>Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security
3614-
* policy that is attached to the server.</p>
3654+
* <p>Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy
3655+
* that is attached to the server or connector. This parameter applies to both server and
3656+
* connector security policies.</p>
36153657
* @public
36163658
*/
36173659
SshCiphers?: string[];
36183660

36193661
/**
3620-
* <p>Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy
3621-
* that is attached to the server.</p>
3662+
* <p>Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that
3663+
* is attached to the server or connector. This parameter applies to both server and connector
3664+
* security policies.</p>
36223665
* @public
36233666
*/
36243667
SshKexs?: string[];
36253668

36263669
/**
3627-
* <p>Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the
3628-
* security policy that is attached to the server.</p>
3670+
* <p>Lists the enabled SSH message authentication code (MAC) encryption algorithms in the
3671+
* security policy that is attached to the server or connector. This parameter applies to both
3672+
* server and connector security policies.</p>
36293673
* @public
36303674
*/
36313675
SshMacs?: string[];
36323676

36333677
/**
3634-
* <p>Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
3678+
* <p>Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the
36353679
* security policy that is attached to the server.</p>
3680+
* <note>
3681+
* <p>This parameter only applies to security policies for servers.</p>
3682+
* </note>
36363683
* @public
36373684
*/
36383685
TlsCiphers?: string[];
3686+
3687+
/**
3688+
* <p>Lists the host key algorithms for the security policy.</p>
3689+
* <note>
3690+
* <p>This parameter only applies to security policies for connectors.</p>
3691+
* </note>
3692+
* @public
3693+
*/
3694+
SshHostKeyAlgorithms?: string[];
3695+
3696+
/**
3697+
* <p>The resource type to which the security policy applies, either server or connector.</p>
3698+
* @public
3699+
*/
3700+
Type?: SecurityPolicyResourceType;
3701+
3702+
/**
3703+
* <p>Lists the file transfer protocols that the security policy applies to.</p>
3704+
* @public
3705+
*/
3706+
Protocols?: SecurityPolicyProtocol[];
36393707
}
36403708

36413709
/**
@@ -3846,7 +3914,7 @@ export interface DescribedServer {
38463914
Protocols?: Protocol[];
38473915

38483916
/**
3849-
* <p>Specifies the name of the security policy that is attached to the server.</p>
3917+
* <p>Specifies the name of the security policy for the server.</p>
38503918
* @public
38513919
*/
38523920
SecurityPolicyName?: string;
@@ -4197,7 +4265,7 @@ export interface DescribeProfileResponse {
41974265
*/
41984266
export interface DescribeSecurityPolicyRequest {
41994267
/**
4200-
* <p>Specifies the name of the security policy that is attached to the server.</p>
4268+
* <p>Specify the text name of the security policy for which you want the details.</p>
42014269
* @public
42024270
*/
42034271
SecurityPolicyName: string | undefined;
@@ -6179,6 +6247,12 @@ export interface UpdateConnectorRequest {
61796247
* @public
61806248
*/
61816249
SftpConfig?: SftpConnectorConfig;
6250+
6251+
/**
6252+
* <p>Specifies the name of the security policy for the connector.</p>
6253+
* @public
6254+
*/
6255+
SecurityPolicyName?: string;
61826256
}
61836257

61846258
/**
@@ -6480,7 +6554,7 @@ export interface UpdateServerRequest {
64806554
Protocols?: Protocol[];
64816555

64826556
/**
6483-
* <p>Specifies the name of the security policy that is attached to the server.</p>
6557+
* <p>Specifies the name of the security policy for the server.</p>
64846558
* @public
64856559
*/
64866560
SecurityPolicyName?: string;

Diff for: clients/client-transfer/src/protocols/Aws_json1_1.ts

+2
Original file line numberDiff line numberDiff line change
@@ -2854,6 +2854,8 @@ const de_ListHostKeysResponse = (output: any, context: __SerdeContext): ListHost
28542854

28552855
// de_SecurityPolicyOptions omitted.
28562856

2857+
// de_SecurityPolicyProtocols omitted.
2858+
28572859
// de_SendWorkflowStepStateResponse omitted.
28582860

28592861
// de_ServiceManagedEgressIpAddresses omitted.

0 commit comments

Comments
 (0)