Skip to content

Commit fad0c2f

Browse files
author
awstools
committed
feat(client-transfer): Add WebAppEndpointPolicy support for WebApps
1 parent cf1dd33 commit fad0c2f

File tree

4 files changed

+79
-7
lines changed

4 files changed

+79
-7
lines changed

‎clients/client-transfer/src/commands/CreateWebAppCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ export interface CreateWebAppCommandOutput extends CreateWebAppResponse, __Metad
5252
* Value: "STRING_VALUE", // required
5353
* },
5454
* ],
55+
* WebAppEndpointPolicy: "FIPS" || "STANDARD",
5556
* };
5657
* const command = new CreateWebAppCommand(input);
5758
* const response = await client.send(command);

‎clients/client-transfer/src/commands/DescribeWebAppCommand.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ export interface DescribeWebAppCommandOutput extends DescribeWebAppResponse, __M
6262
* // Value: "STRING_VALUE", // required
6363
* // },
6464
* // ],
65+
* // WebAppEndpointPolicy: "FIPS" || "STANDARD",
6566
* // },
6667
* // };
6768
*

‎clients/client-transfer/src/models/models_0.ts‎

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3451,6 +3451,20 @@ export namespace WebAppIdentityProviderDetails {
34513451
};
34523452
}
34533453

3454+
/**
3455+
* @public
3456+
* @enum
3457+
*/
3458+
export const WebAppEndpointPolicy = {
3459+
FIPS: "FIPS",
3460+
STANDARD: "STANDARD",
3461+
} as const;
3462+
3463+
/**
3464+
* @public
3465+
*/
3466+
export type WebAppEndpointPolicy = (typeof WebAppEndpointPolicy)[keyof typeof WebAppEndpointPolicy];
3467+
34543468
/**
34553469
* <p>Contains an integer value that represents the value for number of concurrent connections or the user sessions on your web app.</p>
34563470
* @public
@@ -3496,12 +3510,15 @@ export namespace WebAppUnits {
34963510
export interface CreateWebAppRequest {
34973511
/**
34983512
* <p>You can provide a structure that contains the details for the identity provider to use with your web app.</p>
3513+
* <p>For more details about this parameter, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html">Configure your identity provider for Transfer Family web apps</a>.</p>
34993514
* @public
35003515
*/
35013516
IdentityProviderDetails: WebAppIdentityProviderDetails | undefined;
35023517

35033518
/**
35043519
* <p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>
3520+
* <p>Before you enter a custom URL for this parameter, follow the steps described in
3521+
* <a href="https://docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html">Update your access endpoint with a custom URL</a>.</p>
35053522
* @public
35063523
*/
35073524
AccessEndpoint?: string | undefined;
@@ -3517,6 +3534,15 @@ export interface CreateWebAppRequest {
35173534
* @public
35183535
*/
35193536
Tags?: Tag[] | undefined;
3537+
3538+
/**
3539+
* <p>
3540+
* Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>.
3541+
* </p>
3542+
* <p>If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to <code>FIPS</code>.</p>
3543+
* @public
3544+
*/
3545+
WebAppEndpointPolicy?: WebAppEndpointPolicy | undefined;
35203546
}
35213547

35223548
/**
@@ -5248,6 +5274,12 @@ export interface DescribedUser {
52485274
/**
52495275
* <p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described
52505276
* user.</p>
5277+
* <note>
5278+
* <p>To delete the public key body, set its value to zero keys, as shown here:</p>
5279+
* <p>
5280+
* <code>SshPublicKeys: []</code>
5281+
* </p>
5282+
* </note>
52515283
* @public
52525284
*/
52535285
SshPublicKeys?: SshPublicKey[] | undefined;
@@ -5354,6 +5386,15 @@ export interface DescribedWebApp {
53545386
* @public
53555387
*/
53565388
Tags?: Tag[] | undefined;
5389+
5390+
/**
5391+
* <p>
5392+
* Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>.
5393+
* </p>
5394+
* <p>If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be <code>FIPS</code>, which indicates the web app endpoint is FIPS-compliant.</p>
5395+
* @public
5396+
*/
5397+
WebAppEndpointPolicy?: WebAppEndpointPolicy | undefined;
53575398
}
53585399

53595400
/**
@@ -5386,7 +5427,7 @@ export interface DescribedWebAppCustomization {
53865427
LogoFile?: Uint8Array | undefined;
53875428

53885429
/**
5389-
* <p>Returns a icon file data string (in base64 encoding).</p>
5430+
* <p>Returns an icon file data string (in base64 encoding).</p>
53905431
* @public
53915432
*/
53925433
FaviconFile?: Uint8Array | undefined;
@@ -7684,7 +7725,7 @@ export interface UpdateWebAppCustomizationRequest {
76847725
LogoFile?: Uint8Array | undefined;
76857726

76867727
/**
7687-
* <p>Specify icon file data string (in base64 encoding).</p>
7728+
* <p>Specify an icon file data string (in base64 encoding).</p>
76887729
* @public
76897730
*/
76907731
FaviconFile?: Uint8Array | undefined;

‎codegen/sdk-codegen/aws-models/transfer.json‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1347,14 +1347,14 @@
13471347
"IdentityProviderDetails": {
13481348
"target": "com.amazonaws.transfer#WebAppIdentityProviderDetails",
13491349
"traits": {
1350-
"smithy.api#documentation": "<p>You can provide a structure that contains the details for the identity provider to use with your web app.</p>",
1350+
"smithy.api#documentation": "<p>You can provide a structure that contains the details for the identity provider to use with your web app.</p>\n <p>For more details about this parameter, see <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/webapp-identity-center.html\">Configure your identity provider for Transfer Family web apps</a>.</p>",
13511351
"smithy.api#required": {}
13521352
}
13531353
},
13541354
"AccessEndpoint": {
13551355
"target": "com.amazonaws.transfer#WebAppAccessEndpoint",
13561356
"traits": {
1357-
"smithy.api#documentation": "<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>"
1357+
"smithy.api#documentation": "<p>The <code>AccessEndpoint</code> is the URL that you provide to your users for them to interact with the Transfer Family web app. You can specify a custom URL or use the default value.</p>\n <p>Before you enter a custom URL for this parameter, follow the steps described in \n <a href=\"https://docs.aws.amazon.com/transfer/latest/userguide/webapp-customize.html\">Update your access endpoint with a custom URL</a>.</p>"
13581358
}
13591359
},
13601360
"WebAppUnits": {
@@ -1368,6 +1368,12 @@
13681368
"traits": {
13691369
"smithy.api#documentation": "<p>Key-value pairs that can be used to group and search for web apps.</p>"
13701370
}
1371+
},
1372+
"WebAppEndpointPolicy": {
1373+
"target": "com.amazonaws.transfer#WebAppEndpointPolicy",
1374+
"traits": {
1375+
"smithy.api#documentation": "<p>\n Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>.\n </p>\n <p>If you are creating the web app in an Amazon Web Services GovCloud (US) Region, you can set this parameter to <code>FIPS</code>.</p>"
1376+
}
13711377
}
13721378
},
13731379
"traits": {
@@ -3894,7 +3900,7 @@
38943900
"target": "com.amazonaws.transfer#SshPublicKeys",
38953901
"traits": {
38963902
"aws.cloudformation#cfnExcludeProperty": {},
3897-
"smithy.api#documentation": "<p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described\n user.</p>"
3903+
"smithy.api#documentation": "<p>Specifies the public key portion of the Secure Shell (SSH) keys stored for the described\n user.</p>\n <note>\n <p>To delete the public key body, set its value to zero keys, as shown here:</p>\n <p>\n <code>SshPublicKeys: []</code>\n </p>\n </note>"
38983904
}
38993905
},
39003906
"Tags": {
@@ -3961,6 +3967,12 @@
39613967
"traits": {
39623968
"smithy.api#documentation": "<p>Key-value pairs that can be used to group and search for web apps. Tags are metadata attached to web apps for any purpose.</p>"
39633969
}
3970+
},
3971+
"WebAppEndpointPolicy": {
3972+
"target": "com.amazonaws.transfer#WebAppEndpointPolicy",
3973+
"traits": {
3974+
"smithy.api#documentation": "<p>\n Setting for the type of endpoint policy for the web app. The default value is <code>STANDARD</code>.\n </p>\n <p>If your web app was created in an Amazon Web Services GovCloud (US) Region, the value of this parameter can be <code>FIPS</code>, which indicates the web app endpoint is FIPS-compliant.</p>"
3975+
}
39643976
}
39653977
},
39663978
"traits": {
@@ -3999,7 +4011,7 @@
39994011
"FaviconFile": {
40004012
"target": "com.amazonaws.transfer#WebAppFaviconFile",
40014013
"traits": {
4002-
"smithy.api#documentation": "<p>Returns a icon file data string (in base64 encoding).</p>"
4014+
"smithy.api#documentation": "<p>Returns an icon file data string (in base64 encoding).</p>"
40034015
}
40044016
}
40054017
},
@@ -10844,7 +10856,7 @@
1084410856
"FaviconFile": {
1084510857
"target": "com.amazonaws.transfer#WebAppFaviconFile",
1084610858
"traits": {
10847-
"smithy.api#documentation": "<p>Specify icon file data string (in base64 encoding).</p>"
10859+
"smithy.api#documentation": "<p>Specify an icon file data string (in base64 encoding).</p>"
1084810860
}
1084910861
}
1085010862
},
@@ -11107,6 +11119,23 @@
1110711119
}
1110811120
}
1110911121
},
11122+
"com.amazonaws.transfer#WebAppEndpointPolicy": {
11123+
"type": "enum",
11124+
"members": {
11125+
"FIPS": {
11126+
"target": "smithy.api#Unit",
11127+
"traits": {
11128+
"smithy.api#enumValue": "FIPS"
11129+
}
11130+
},
11131+
"STANDARD": {
11132+
"target": "smithy.api#Unit",
11133+
"traits": {
11134+
"smithy.api#enumValue": "STANDARD"
11135+
}
11136+
}
11137+
}
11138+
},
1111011139
"com.amazonaws.transfer#WebAppFaviconFile": {
1111111140
"type": "blob",
1111211141
"traits": {

0 commit comments

Comments
 (0)