Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amplifyuibuilder-api-016	amplifyuibuilder-api.pdf	16	}, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 90 AmplifyUIBuilder Welcome "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { Response Syntax API Version 2021-08-11 91 AmplifyUIBuilder Welcome "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": "string", "name": "string", "overrides": { "string" : { Response Syntax API Version 2021-08-11 92 AmplifyUIBuilder Welcome "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", Response Syntax API Version 2021-08-11 93 AmplifyUIBuilder Welcome "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities Represents the conﬁguration of the exported components. Type: Array of Component objects nextToken The pagination token that's included if more results are available. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2021-08-11 94 AmplifyUIBuilder InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Welcome HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 95 AmplifyUIBuilder ExportForms Welcome Exports form conﬁgurations to code that is ready to integrate into an Amplify app. Request Syntax GET /export/app/appId/environment/environmentName/forms?nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to export forms to. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "entities": [ { "appId": "string", "cta": { "cancel": { ExportForms API Version 2021-08-11 96 AmplifyUIBuilder Welcome "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, Response Syntax API Version 2021-08-11 97 AmplifyUIBuilder Welcome "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat":
amplifyuibuilder-api-017	amplifyuibuilder-api.pdf	17	"inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, Response Syntax API Version 2021-08-11 97 AmplifyUIBuilder Welcome "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], Response Syntax API Version 2021-08-11 98 AmplifyUIBuilder Welcome "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "id": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, "tags": { "string" : "string" } } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities Represents the conﬁguration of the exported forms. Response Elements API Version 2021-08-11 99 AmplifyUIBuilder Type: Array of Form objects nextToken The pagination token that's included if more results are available. Welcome Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 100 AmplifyUIBuilder Welcome See Also API Version 2021-08-11 101 AmplifyUIBuilder ExportThemes Welcome Exports theme conﬁgurations to code that is ready to integrate into an Amplify app. Request Syntax GET /export/app/appId/environment/environmentName/themes?nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app to export the themes to. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "entities": [ { "appId": "string", "createdAt": "string", ExportThemes API Version 2021-08-11 102 AmplifyUIBuilder Welcome "environmentName": "string", "id": "string", "modifiedAt": "string", "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities Represents the conﬁguration of the exported themes. Response Elements API Version 2021-08-11 103 AmplifyUIBuilder Type: Array of Theme objects nextToken The pagination token that's included if more results are available. Welcome Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 104 AmplifyUIBuilder Welcome See Also API Version 2021-08-11 105 Welcome AmplifyUIBuilder GetCodegenJob Returns an existing code generation job. Request Syntax GET /app/appId/environment/environmentName/codegen-jobs/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app associated with the code generation job. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment that is
amplifyuibuilder-api-018	amplifyuibuilder-api.pdf	18	SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2021-08-11 104 AmplifyUIBuilder Welcome See Also API Version 2021-08-11 105 Welcome AmplifyUIBuilder GetCodegenJob Returns an existing code generation job. Request Syntax GET /app/appId/environment/environmentName/codegen-jobs/id HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app associated with the code generation job. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment that is a part of the Amplify app associated with the code generation job. Required: Yes id The unique ID of the code generation job. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetCodegenJob API Version 2021-08-11 106 AmplifyUIBuilder Welcome { "appId": "string", "asset": { "downloadUrl": "string" }, "autoGenerateForms": boolean, "createdAt": "string", "dependencies": [ { "isSemVer": boolean, "name": "string", "reason": "string", "supportedVersion": "string" } ], "environmentName": "string", "features": { "isNonModelSupported": boolean, "isRelationshipSupported": boolean }, "genericDataSchema": { "dataSourceType": "string", "enums": { "string" : { "values": [ "string" ] } }, "models": { "string" : { "fields": { "string" : { "dataType": "string", "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], Response Syntax API Version 2021-08-11 107 AmplifyUIBuilder Welcome "relatedModelName": "string", "type": "string" }, "required": boolean } }, "isJoinTable": boolean, "primaryKeys": [ "string" ] } }, "nonModels": { "string" : { "fields": { "string" : { "dataType": "string", "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], "relatedModelName": "string", "type": "string" }, "required": boolean } } } } }, "id": "string", "modifiedAt": "string", "renderConfig": { ... }, "status": "string", "statusMessage": "string", "tags": { "string" : "string" } Response Syntax API Version 2021-08-11 108 Welcome AmplifyUIBuilder } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The ID of the Amplify app associated with the code generation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ asset The CodegenJobAsset to use for the code generation job. Type: CodegenJobAsset object autoGenerateForms Speciﬁes whether to autogenerate forms in the code generation job. Type: Boolean createdAt The time that the code generation job was created. Type: Timestamp dependencies Lists the dependency packages that may be required for the project code to run. Type: Array of CodegenDependency objects environmentName The name of the backend environment associated with the code generation job. Response Elements API Version 2021-08-11 109 AmplifyUIBuilder Type: String features Welcome Describes the feature ﬂags that you can specify for a code generation job. Type: CodegenFeatureFlags object genericDataSchema Describes the data schema for a code generation job. Type: CodegenJobGenericDataSchema object id The unique ID for the code generation job. Type: String modiﬁedAt The time that the code generation job was modiﬁed. Type: Timestamp renderConﬁg Describes the conﬁguration information for rendering the UI component associated with the code generation job. Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. status The status of the code generation job. Type: String Valid Values: in_progress \| failed \| succeeded statusMessage The customized status message for the code generation job. Type: String Response Elements API Version 2021-08-11 110 AmplifyUIBuilder tags Welcome One or more key-value pairs to use when tagging the code generation job. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2021-08-11 111 Welcome AmplifyUIBuilder • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11
amplifyuibuilder-api-019	amplifyuibuilder-api.pdf	19	404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2021-08-11 111 Welcome AmplifyUIBuilder • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 112 AmplifyUIBuilder GetComponent Returns an existing component for an Amplify app. Request Syntax GET /app/appId/environment/environmentName/components/id HTTP/1.1 Welcome URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes id The unique ID of the component. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "bindingProperties": { "string" : { GetComponent API Version 2021-08-11 113 AmplifyUIBuilder Welcome "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { Response Syntax API Version 2021-08-11 114 AmplifyUIBuilder Welcome "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, Response Syntax API Version 2021-08-11 115 AmplifyUIBuilder Welcome "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Response Syntax API Version 2021-08-11 116 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", Response Syntax API Version 2021-08-11 117 AmplifyUIBuilder Welcome "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", Response Syntax API Version 2021-08-11 118 AmplifyUIBuilder Welcome "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, Response Syntax API Version 2021-08-11 119 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version
amplifyuibuilder-api-020	amplifyuibuilder-api.pdf	20	"property": "string", "then": "ComponentProperty" }, "configured": boolean, Response Syntax API Version 2021-08-11 119 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version 2021-08-11 120 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, Response Syntax API Version 2021-08-11 121 AmplifyUIBuilder Welcome "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], Response Syntax API Version 2021-08-11 122 AmplifyUIBuilder Welcome "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "createdAt": "string", "environmentName": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { Response Syntax API Version 2021-08-11 123 AmplifyUIBuilder Welcome "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ Response Syntax API Version 2021-08-11 124 AmplifyUIBuilder Welcome "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", Response Syntax API Version 2021-08-11 125 AmplifyUIBuilder Welcome "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Response Syntax API Version 2021-08-11 126 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", Response Syntax API Version 2021-08-11 127 AmplifyUIBuilder Welcome "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version
amplifyuibuilder-api-021	amplifyuibuilder-api.pdf	21	"string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", Response Syntax API Version 2021-08-11 127 AmplifyUIBuilder Welcome "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Response Syntax API Version 2021-08-11 128 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", Response Syntax API Version 2021-08-11 129 AmplifyUIBuilder Welcome "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": "string", "name": "string", "overrides": { "string" : { "string" : "string" Response Syntax API Version 2021-08-11 130 Welcome AmplifyUIBuilder } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", Response Syntax API Version 2021-08-11 131 AmplifyUIBuilder Welcome "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the component. Type: String bindingProperties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects Response Elements API Version 2021-08-11 132 AmplifyUIBuilder collectionProperties Welcome The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. createdAt The time that the component was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Type: String events Describes the events that can be raised on the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map id The unique ID of the component. Type: String modiﬁedAt The time that the component was modiﬁed. Type: Timestamp Response Elements API Version 2021-08-11 133 AmplifyUIBuilder name The name of the component. Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides. Type: String to string to string map map properties Describes the component's properties. You can't specify tags as a valid property for properties. Type: String to ComponentProperty object map schemaVersion The schema version of the component when it was imported. Type: String sourceId The unique ID of the component in its original source system, such as Figma. Type: String tags One or more key-value pairs to use when tagging the component. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Response Elements API Version 2021-08-11 134 AmplifyUIBuilder variants Welcome A list of the component's variants. A variant is a unique style
amplifyuibuilder-api-022	amplifyuibuilder-api.pdf	22	properties. Type: String to ComponentProperty object map schemaVersion The schema version of the component when it was imported. Type: String sourceId The unique ID of the component in its original source system, such as Figma. Type: String tags One or more key-value pairs to use when tagging the component. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Response Elements API Version 2021-08-11 134 AmplifyUIBuilder variants Welcome A list of the component's variants. A variant is a unique style conﬁguration of a main component. Type: Array of ComponentVariant objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 Errors API Version 2021-08-11 135 AmplifyUIBuilder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 136 AmplifyUIBuilder GetForm Returns an existing form for an Amplify app. Request Syntax GET /app/appId/environment/environmentName/forms/id HTTP/1.1 Welcome URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes id The unique ID of the form. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "cta": { "cancel": { GetForm API Version 2021-08-11 137 AmplifyUIBuilder Welcome "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, Response Syntax API Version 2021-08-11 138 AmplifyUIBuilder Welcome "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], Response Syntax API Version 2021-08-11 139 AmplifyUIBuilder Welcome "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "id": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the form. Type: String Response Elements API Version 2021-08-11 140 Welcome AmplifyUIBuilder cta Stores the call to action conﬁguration for the form. Type: FormCTA object dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object environmentName The name of the backend environment that is a part of the Amplify app. Type: String ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map formActionType The operation to perform on the speciﬁed form. Type: String Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none name The name of the form. Response Elements API Version 2021-08-11 141 AmplifyUIBuilder Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. schemaVersion The schema version of the form when it was imported. Type: String sectionalElements Stores the visual helper elements for the form that are not associated with any
amplifyuibuilder-api-023	amplifyuibuilder-api.pdf	23	map formActionType The operation to perform on the speciﬁed form. Type: String Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none name The name of the form. Response Elements API Version 2021-08-11 141 AmplifyUIBuilder Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. schemaVersion The schema version of the form when it was imported. Type: String sectionalElements Stores the visual helper elements for the form that are not associated with any data. Type: String to SectionalElement object map style Stores the conﬁguration for the form's style. Type: FormStyle object tags One or more key-value pairs to use when tagging the form. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Errors API Version 2021-08-11 142 AmplifyUIBuilder HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. Welcome HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 143 AmplifyUIBuilder GetMetadata Returns existing metadata for an Amplify app. Request Syntax GET /app/appId/environment/environmentName/metadata HTTP/1.1 Welcome URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "features": { "string" : "string" } } GetMetadata API Version 2021-08-11 144 AmplifyUIBuilder Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. features Represents the conﬁguration settings for the features metadata. Type: String to string map Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 Response Elements API Version 2021-08-11 145 AmplifyUIBuilder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 146 AmplifyUIBuilder GetTheme Returns an existing theme for an Amplify app. Request Syntax GET /app/appId/environment/environmentName/themes/id HTTP/1.1 Welcome URI Request Parameters The request uses the following URI parameters. appId The unique ID of the Amplify app. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes id The unique ID for the theme. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", GetTheme API Version 2021-08-11 147 AmplifyUIBuilder Welcome "createdAt": "string", "environmentName": "string", "id": "string", "modifiedAt": "string", "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID for the Amplify app associated with the theme. Type: String Response Elements API Version 2021-08-11 148 AmplifyUIBuilder createdAt The time that the theme was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Welcome Type: String id The ID for the theme. Type: String modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp name The name of the theme. Type: String Length Constraints:
amplifyuibuilder-api-024	amplifyuibuilder-api.pdf	24	the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID for the Amplify app associated with the theme. Type: String Response Elements API Version 2021-08-11 148 AmplifyUIBuilder createdAt The time that the theme was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Welcome Type: String id The ID for the theme. Type: String modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the properties that can be overriden to customize a theme. Type: Array of ThemeValues objects tags One or more key-value pairs to use when tagging the theme. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Response Elements API Version 2021-08-11 149 AmplifyUIBuilder Welcome Value Length Constraints: Minimum length of 1. Maximum length of 256. values A list of key-value pairs that deﬁnes the properties of the theme. Type: Array of ThemeValues objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 Errors API Version 2021-08-11 150 AmplifyUIBuilder • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 151 AmplifyUIBuilder ListCodegenJobs Welcome Retrieves a list of code generation jobs for a speciﬁed Amplify app and backend environment. Request Syntax GET /app/appId/environment/environmentName/codegen-jobs? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes maxResults The maximum number of jobs to retrieve. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token to request the next page of results. Request Body The request does not have a request body. ListCodegenJobs API Version 2021-08-11 152 Welcome AmplifyUIBuilder Response Syntax HTTP/1.1 200 Content-type: application/json { "entities": [ { "appId": "string", "createdAt": "string", "environmentName": "string", "id": "string", "modifiedAt": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities The list of code generation jobs for the Amplify app. Type: Array of CodegenJobSummary objects nextToken The pagination token that's included if more results are available. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. Response Syntax API Version 2021-08-11 153 AmplifyUIBuilder HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Welcome HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 154 AmplifyUIBuilder ListComponents Welcome Retrieves a list of components for a speciﬁed Amplify app and backend environment. Request Syntax GET /app/appId/environment/environmentName/components? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes maxResults The maximum number of components to retrieve. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListComponents API Version 2021-08-11 155 Welcome AmplifyUIBuilder Content-type: application/json { "entities": [ { "appId": "string",
amplifyuibuilder-api-025	amplifyuibuilder-api.pdf	25	Request Syntax GET /app/appId/environment/environmentName/components? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes maxResults The maximum number of components to retrieve. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListComponents API Version 2021-08-11 155 Welcome AmplifyUIBuilder Content-type: application/json { "entities": [ { "appId": "string", "componentType": "string", "environmentName": "string", "id": "string", "name": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities The list of components for the Amplify app. Type: Array of ComponentSummary objects nextToken The pagination token that's included if more results are available. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 Response Elements API Version 2021-08-11 156 AmplifyUIBuilder InvalidParameterException Welcome An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 157 AmplifyUIBuilder ListForms Welcome Retrieves a list of forms for a speciﬁed Amplify app and backend environment. Request Syntax GET /app/appId/environment/environmentName/forms? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes maxResults The maximum number of forms to retrieve. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListForms API Version 2021-08-11 158 AmplifyUIBuilder Welcome { "entities": [ { "appId": "string", "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "formActionType": "string", "id": "string", "name": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities The list of forms for the Amplify app. Type: Array of FormSummary objects nextToken The pagination token that's included if more results are available. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. Response Elements API Version 2021-08-11 159 AmplifyUIBuilder HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Welcome HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 160 AmplifyUIBuilder ListTagsForResource Welcome Returns a list of tags for a speciﬁed Amazon Resource Name (ARN). Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to list tags. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ListTagsForResource API Version 2021-08-11 161 AmplifyUIBuilder tags Welcome A list of tag key value pairs for a speciﬁed Amazon Resource Name (ARN). Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range
amplifyuibuilder-api-026	amplifyuibuilder-api.pdf	26	HTTP 200 response. The following data is returned in JSON format by the service. ListTagsForResource API Version 2021-08-11 161 AmplifyUIBuilder tags Welcome A list of tag key value pairs for a speciﬁed Amazon Resource Name (ARN). Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 Errors API Version 2021-08-11 162 AmplifyUIBuilder See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 163 AmplifyUIBuilder ListThemes Welcome Retrieves a list of themes for a speciﬁed Amplify app and backend environment. Request Syntax GET /app/appId/environment/environmentName/themes? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes maxResults The maximum number of theme results to return in the response. Valid Range: Minimum value of 1. Maximum value of 100. nextToken The token to request the next page of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListThemes API Version 2021-08-11 164 AmplifyUIBuilder Welcome { "entities": [ { "appId": "string", "environmentName": "string", "id": "string", "name": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. entities The list of themes for the Amplify app. Type: Array of ThemeSummary objects nextToken The pagination token that's returned if more results are available. Type: String Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Response Elements API Version 2021-08-11 165 AmplifyUIBuilder HTTP Status Code: 400 See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 166 AmplifyUIBuilder PutMetadataFlag Stores the metadata information about a feature on a form. Request Syntax Welcome PUT /app/appId/environment/environmentName/metadata/features/featureName HTTP/1.1 Content-type: application/json { "newValue": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Required: Yes featureName The name of the feature associated with the metadata. Required: Yes Request Body The request accepts the following data in JSON format. newValue The new information to store. PutMetadataFlag API Version 2021-08-11 167 Welcome AmplifyUIBuilder Type: String Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Response Syntax API Version 2021-08-11 168 AmplifyUIBuilder • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python •
amplifyuibuilder-api-027	amplifyuibuilder-api.pdf	27	value was supplied for the input parameter. HTTP Status Code: 400 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 Response Syntax API Version 2021-08-11 168 AmplifyUIBuilder • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 169 AmplifyUIBuilder RefreshToken Note This is for internal use. Welcome Amplify uses this action to refresh a previously issued access token that might have expired. Request Syntax POST /tokens/provider/refresh HTTP/1.1 Content-type: application/json { "clientId": "string", "token": "string" } URI Request Parameters The request uses the following URI parameters. provider The third-party provider for the token. The only valid value is figma. Valid Values: figma Required: Yes Request Body The request accepts the following data in JSON format. clientId The ID of the client to request the token from. Type: String RefreshToken API Version 2021-08-11 170 AmplifyUIBuilder Required: No token Welcome The token to use to refresh a previously issued access token that might have expired. Type: String Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "accessToken": "string", "expiresIn": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessToken The access token. Type: String expiresIn The date and time when the new access token expires. Type: Integer Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2021-08-11 171 AmplifyUIBuilder InvalidParameterException Welcome An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 172 AmplifyUIBuilder StartCodegenJob Welcome Starts a code generation job for a speciﬁed Amplify app and backend environment. Request Syntax POST /app/appId/environment/environmentName/codegen-jobs?clientToken=clientToken HTTP/1.1 Content-type: application/json { "autoGenerateForms": boolean, "features": { "isNonModelSupported": boolean, "isRelationshipSupported": boolean }, "genericDataSchema": { "dataSourceType": "string", "enums": { "string" : { "values": [ "string" ] } }, "models": { "string" : { "fields": { "string" : { "dataType": "string", "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], "relatedModelName": "string", "type": "string" }, "required": boolean StartCodegenJob API Version 2021-08-11 173 Welcome AmplifyUIBuilder } }, "isJoinTable": boolean, "primaryKeys": [ "string" ] } }, "nonModels": { "string" : { "fields": { "string" : { "dataType": "string", "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], "relatedModelName": "string", "type": "string" }, "required": boolean } } } } }, "renderConfig": { ... }, "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. URI Request Parameters API Version 2021-08-11 174 AmplifyUIBuilder appId Welcome The unique ID for the Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes clientToken The idempotency token used to ensure that the code generation job request completes only once. environmentName The name of the backend environment that is a part of the Amplify app. Required: Yes Request Body The request accepts the following data in JSON format. autoGenerateForms Speciﬁes whether to autogenerate forms in the code generation job. Type: Boolean Required: No features The feature ﬂags for a code generation job. Type: CodegenFeatureFlags object Required: No genericDataSchema The data schema to use for a code generation job. Type: CodegenJobGenericDataSchema object Request Body API Version 2021-08-11 175 AmplifyUIBuilder Required: No renderConﬁg Welcome The code generation conﬁguration for the codegen job. Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes tags One or more key-value pairs to use when tagging the code generation job data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json {
amplifyuibuilder-api-028	amplifyuibuilder-api.pdf	28	generation job. Type: CodegenJobGenericDataSchema object Request Body API Version 2021-08-11 175 AmplifyUIBuilder Required: No renderConﬁg Welcome The code generation conﬁguration for the codegen job. Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes tags One or more key-value pairs to use when tagging the code generation job data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "asset": { "downloadUrl": "string" }, "autoGenerateForms": boolean, "createdAt": "string", "dependencies": [ { "isSemVer": boolean, "name": "string", "reason": "string", "supportedVersion": "string" } Response Syntax API Version 2021-08-11 176 AmplifyUIBuilder Welcome ], "environmentName": "string", "features": { "isNonModelSupported": boolean, "isRelationshipSupported": boolean }, "genericDataSchema": { "dataSourceType": "string", "enums": { "string" : { "values": [ "string" ] } }, "models": { "string" : { "fields": { "string" : { "dataType": "string", "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], "relatedModelName": "string", "type": "string" }, "required": boolean } }, "isJoinTable": boolean, "primaryKeys": [ "string" ] } }, "nonModels": { "string" : { "fields": { "string" : { "dataType": "string", Response Syntax API Version 2021-08-11 177 AmplifyUIBuilder Welcome "dataTypeValue": "string", "isArray": boolean, "readOnly": boolean, "relationship": { "associatedFields": [ "string" ], "belongsToFieldOnRelatedModel": "string", "canUnlinkAssociatedModel": boolean, "isHasManyIndex": boolean, "relatedJoinFieldName": "string", "relatedJoinTableName": "string", "relatedModelFields": [ "string" ], "relatedModelName": "string", "type": "string" }, "required": boolean } } } } }, "id": "string", "modifiedAt": "string", "renderConfig": { ... }, "status": "string", "statusMessage": "string", "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The ID of the Amplify app associated with the code generation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Response Elements API Version 2021-08-11 178 Welcome AmplifyUIBuilder Pattern: d[a-z0-9]+ asset The CodegenJobAsset to use for the code generation job. Type: CodegenJobAsset object autoGenerateForms Speciﬁes whether to autogenerate forms in the code generation job. Type: Boolean createdAt The time that the code generation job was created. Type: Timestamp dependencies Lists the dependency packages that may be required for the project code to run. Type: Array of CodegenDependency objects environmentName The name of the backend environment associated with the code generation job. Type: String features Describes the feature ﬂags that you can specify for a code generation job. Type: CodegenFeatureFlags object genericDataSchema Describes the data schema for a code generation job. Type: CodegenJobGenericDataSchema object id The unique ID for the code generation job. Type: String Response Elements API Version 2021-08-11 179 AmplifyUIBuilder modiﬁedAt The time that the code generation job was modiﬁed. Type: Timestamp renderConﬁg Welcome Describes the conﬁguration information for rendering the UI component associated with the code generation job. Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. status The status of the code generation job. Type: String Valid Values: in_progress \| failed \| succeeded statusMessage The customized status message for the code generation job. Type: String tags One or more key-value pairs to use when tagging the code generation job. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2021-08-11 180 AmplifyUIBuilder InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Welcome HTTP Status Code: 400 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 181 Welcome AmplifyUIBuilder TagResource Tags the resource with a tag key and value. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to tag a resource. Required: Yes Request Body The request accepts the following data in JSON format. tags
amplifyuibuilder-api-029	amplifyuibuilder-api.pdf	29	for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 181 Welcome AmplifyUIBuilder TagResource Tags the resource with a tag key and value. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to tag a resource. Required: Yes Request Body The request accepts the following data in JSON format. tags A list of tag key value pairs for a speciﬁed Amazon Resource Name (ARN). Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. TagResource API Version 2021-08-11 182 AmplifyUIBuilder Required: Yes Response Syntax HTTP/1.1 200 Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 Response Syntax API Version 2021-08-11 183 AmplifyUIBuilder See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 184 Welcome AmplifyUIBuilder UntagResource Untags a resource with a speciﬁed Amazon Resource Name (ARN). Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to untag a resource. Required: Yes tagKeys The tag keys to use to untag a resource. Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. UntagResource API Version 2021-08-11 185 AmplifyUIBuilder Errors Welcome For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceNotFoundException The requested resource does not exist, or access was denied. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 UnauthorizedException You don't have permission to perform this operation. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2021-08-11 186 AmplifyUIBuilder • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 187 AmplifyUIBuilder UpdateComponent Updates an existing component. Request Syntax Welcome PATCH /app/appId/environment/environmentName/components/id?clientToken=clientToken HTTP/1.1 Content-type: application/json { "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ UpdateComponent API Version 2021-08-11 188 AmplifyUIBuilder Welcome "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string",
amplifyuibuilder-api-030	amplifyuibuilder-api.pdf	30	}, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ UpdateComponent API Version 2021-08-11 188 AmplifyUIBuilder Welcome "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", Request Syntax API Version 2021-08-11 189 AmplifyUIBuilder Welcome "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { Request Syntax API Version 2021-08-11 190 AmplifyUIBuilder Welcome "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", Request Syntax API Version 2021-08-11 191 AmplifyUIBuilder Welcome "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } Request Syntax API Version 2021-08-11 192 Welcome AmplifyUIBuilder }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, Request Syntax API Version 2021-08-11 193 AmplifyUIBuilder Welcome "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", Request Syntax API Version 2021-08-11 194 AmplifyUIBuilder Welcome "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" Request Syntax API Version 2021-08-11 195 Welcome AmplifyUIBuilder }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Request Syntax API Version 2021-08-11 196 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { Request
amplifyuibuilder-api-031	amplifyuibuilder-api.pdf	31	"field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Request Syntax API Version 2021-08-11 196 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { Request Syntax API Version 2021-08-11 197 AmplifyUIBuilder Welcome "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, Request Syntax API Version 2021-08-11 198 AmplifyUIBuilder Welcome "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } Request Syntax API Version 2021-08-11 199 Welcome AmplifyUIBuilder }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", Request Syntax API Version 2021-08-11 200 AmplifyUIBuilder Welcome "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" Request Syntax API Version 2021-08-11 201 Welcome AmplifyUIBuilder ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", Request Syntax API Version 2021-08-11 202 AmplifyUIBuilder Welcome "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, Request Syntax API Version 2021-08-11 203 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Request Syntax API Version 2021-08-11 204 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" } } } }, "id": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean,
amplifyuibuilder-api-032	amplifyuibuilder-api.pdf	32	}, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", Request Syntax API Version 2021-08-11 204 AmplifyUIBuilder Welcome "userAttribute": "string", "value": "string" } } } }, "id": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", Request Syntax API Version 2021-08-11 205 AmplifyUIBuilder Welcome "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } URI Request Parameters The request uses the following URI parameters. appId The unique ID for the Amplify app. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is part of the Amplify app. Required: Yes URI Request Parameters API Version 2021-08-11 206 Welcome AmplifyUIBuilder id The unique ID for the component. Required: Yes Request Body The request accepts the following data in JSON format. bindingProperties The data binding information for the component's properties. Type: String to ComponentBindingPropertiesValue object map Required: No children The components that are instances of the main component. Type: Array of ComponentChild objects Required: No collectionProperties The conﬁguration for binding a component's properties to a data model. Use this for a collection component. Type: String to ComponentDataConﬁguration object map Required: No componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No Request Body API Version 2021-08-11 207 AmplifyUIBuilder events Welcome The event conﬁguration for the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map Required: No id The unique ID of the component to update. Type: String Required: No name The name of the component to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No overrides Describes the properties that can be overriden to customize the component. Type: String to string to string map map Required: No properties Describes the component's properties. Type: String to ComponentProperty object map Required: No schemaVersion The schema version of the component when it was imported. Type: String Request Body API Version 2021-08-11 208 AmplifyUIBuilder Required: No sourceId Welcome The unique ID of the component in its original source system, such as Figma. Type: String Required: No variants A list of the unique variants of the main component being updated. Type: Array of ComponentVariant objects Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" Response Syntax API Version 2021-08-11 209 AmplifyUIBuilder Welcome ] } ], "slotName": "string", "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "componentType": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", Response Syntax API Version 2021-08-11 210 AmplifyUIBuilder Welcome "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, Response Syntax API Version 2021-08-11 211 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", Response Syntax API Version 2021-08-11 212 AmplifyUIBuilder Welcome "property":
amplifyuibuilder-api-033	amplifyuibuilder-api.pdf	33	"then": "ComponentProperty" }, Response Syntax API Version 2021-08-11 211 AmplifyUIBuilder Welcome "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", Response Syntax API Version 2021-08-11 212 AmplifyUIBuilder Welcome "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", Response Syntax API Version 2021-08-11 213 AmplifyUIBuilder Welcome "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { Response Syntax API Version 2021-08-11 214 AmplifyUIBuilder Welcome "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", Response Syntax API Version 2021-08-11 215 AmplifyUIBuilder Welcome "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" Response Syntax API Version 2021-08-11 216 AmplifyUIBuilder Welcome }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "name": "string", "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, Response Syntax API Version 2021-08-11 217 AmplifyUIBuilder Welcome "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "sourceId": "string" } ], "collectionProperties": { "string" : { "identifiers": [ "string" ], "model": "string", "predicate": { "and": [ "Predicate" ], "field": "string", "operand": "string", "operandType": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ Response Syntax API Version 2021-08-11 218 AmplifyUIBuilder Welcome { "direction": "string", "field": "string" } ] } }, "componentType": "string", "createdAt": "string", "environmentName": "string", "events": { "string" : { "action": "string", "bindingEvent": "string", "parameters": { "anchor": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, Response Syntax API Version 2021-08-11 219 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 220 AmplifyUIBuilder Welcome
amplifyuibuilder-api-034	amplifyuibuilder-api.pdf	34	"configured": boolean, Response Syntax API Version 2021-08-11 219 AmplifyUIBuilder Welcome "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "fields": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", Response Syntax API Version 2021-08-11 220 AmplifyUIBuilder Welcome "type": "string", "userAttribute": "string", "value": "string" } }, "global": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "id": { Response Syntax API Version 2021-08-11 221 AmplifyUIBuilder Welcome "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "model": "string", "state": { "componentName": "string", "property": "string", "set": { "bindingProperties": { "field": "string", Response Syntax API Version 2021-08-11 222 AmplifyUIBuilder Welcome "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "target": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", Response Syntax API Version 2021-08-11 223 AmplifyUIBuilder Welcome "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "type": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" Response Syntax API Version 2021-08-11 224 AmplifyUIBuilder Welcome }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" }, "url": { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { Response Syntax API Version 2021-08-11 225 AmplifyUIBuilder Welcome "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": "string", "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" Response Syntax API Version 2021-08-11 226 AmplifyUIBuilder Welcome }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } Response Syntax API Version 2021-08-11 227 AmplifyUIBuilder Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the component. Type: String bindingProperties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects collectionProperties The data binding conﬁguration for the component's
amplifyuibuilder-api-035	amplifyuibuilder-api.pdf	35	} ] } Response Syntax API Version 2021-08-11 227 AmplifyUIBuilder Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the component. Type: String bindingProperties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects collectionProperties The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. createdAt The time that the component was created. Response Elements API Version 2021-08-11 228 AmplifyUIBuilder Type: Timestamp environmentName Welcome The name of the backend environment that is a part of the Amplify app. Type: String events Describes the events that can be raised on the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map id The unique ID of the component. Type: String modiﬁedAt The time that the component was modiﬁed. Type: Timestamp name The name of the component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides. Type: String to string to string map map properties Describes the component's properties. You can't specify tags as a valid property for properties. Type: String to ComponentProperty object map Response Elements API Version 2021-08-11 229 AmplifyUIBuilder schemaVersion Welcome The schema version of the component when it was imported. Type: String sourceId The unique ID of the component in its original source system, such as Figma. Type: String tags One or more key-value pairs to use when tagging the component. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. variants A list of the component's variants. A variant is a unique style conﬁguration of a main component. Type: Array of ComponentVariant objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. Errors API Version 2021-08-11 230 AmplifyUIBuilder HTTP Status Code: 400 ResourceConﬂictException Welcome The resource speciﬁed in the request conﬂicts with an existing resource. HTTP Status Code: 409 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 231 AmplifyUIBuilder UpdateForm Updates an existing form. Request Syntax Welcome PATCH /app/appId/environment/environmentName/forms/id?clientToken=clientToken HTTP/1.1 Content-type: application/json { "cta": { "cancel": { "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", UpdateForm API Version 2021-08-11 232 AmplifyUIBuilder Welcome "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], Request Syntax API Version 2021-08-11 233 AmplifyUIBuilder Welcome "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string",
amplifyuibuilder-api-036	amplifyuibuilder-api.pdf	36	"string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], Request Syntax API Version 2021-08-11 233 AmplifyUIBuilder Welcome "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } } } URI Request Parameters The request uses the following URI parameters. URI Request Parameters API Version 2021-08-11 234 Welcome AmplifyUIBuilder appId The unique ID for the Amplify app. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is part of the Amplify app. Required: Yes id The unique ID for the form. Required: Yes Request Body The request accepts the following data in JSON format. cta The FormCTA object that stores the call to action conﬁguration for the form. Type: FormCTA object Required: No dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: No ﬁelds The conﬁguration information for the form's ﬁelds. Type: String to FieldConﬁg object map Request Body API Version 2021-08-11 235 Welcome AmplifyUIBuilder Required: No formActionType Speciﬁes whether to perform a create or update action on the form. Type: String Valid Values: create \| update Required: No labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none Required: No name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No schemaVersion The schema version of the form. Type: String Required: No sectionalElements The conﬁguration information for the visual helper elements for the form. These elements are not associated with any data. Type: String to SectionalElement object map Required: No Request Body API Version 2021-08-11 236 Welcome AmplifyUIBuilder style The conﬁguration for the form's style. Type: FormStyle object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "cta": { "cancel": { "children": "string", "excluded": boolean, "position": { ... } }, "clear": { "children": "string", "excluded": boolean, "position": { ... } }, "position": "string", "submit": { "children": "string", "excluded": boolean, "position": { ... } } }, "dataType": { "dataSourceType": "string", "dataTypeName": "string" }, "environmentName": "string", "fields": { "string" : { "excluded": boolean, "inputType": { "defaultChecked": boolean, Response Syntax API Version 2021-08-11 237 AmplifyUIBuilder Welcome "defaultCountryCode": "string", "defaultValue": "string", "descriptiveText": "string", "fileUploaderConfig": { "acceptedFileTypes": [ "string" ], "accessLevel": "string", "isResumable": boolean, "maxFileCount": number, "maxSize": number, "showThumbnails": boolean }, "isArray": boolean, "maxValue": number, "minValue": number, "name": "string", "placeholder": "string", "readOnly": boolean, "required": boolean, "step": number, "type": "string", "value": "string", "valueMappings": { "bindingProperties": { "string" : { "bindingProperties": { "model": "string" }, "type": "string" } }, "values": [ { "displayValue": { "bindingProperties": { "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" }, "value": { "bindingProperties": { Response Syntax API Version 2021-08-11 238 AmplifyUIBuilder Welcome "field": "string", "property": "string" }, "concat": [ "FormInputValueProperty" ], "value": "string" } } ] } }, "label": "string", "position": { ... }, "validations": [ { "numValues": [ number ], "strValues": [ "string" ], "type": "string", "validationMessage": "string" } ] } }, "formActionType": "string", "id": "string", "labelDecorator": "string", "name": "string", "schemaVersion": "string", "sectionalElements": { "string" : { "excluded": boolean, "level": number, "orientation": "string", "position": { ... }, "text": "string", "type": "string" } }, "style": { "horizontalGap": { ... }, "outerPadding": { ... }, "verticalGap": { ... } }, Response Syntax API Version 2021-08-11 239 AmplifyUIBuilder "tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID of the Amplify app associated with the form. Type: String cta Stores the call to action conﬁguration for the form. Type: FormCTA object dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object environmentName The name of the backend environment that is a part of the Amplify app. Type: String ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map formActionType The operation to perform on the speciﬁed form. Type: String Response Elements Welcome API Version 2021-08-11 240 AmplifyUIBuilder Welcome Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none name The name of the form. Type: String
amplifyuibuilder-api-037	amplifyuibuilder-api.pdf	37	to create the form. Type: FormDataTypeConﬁg object environmentName The name of the backend environment that is a part of the Amplify app. Type: String ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map formActionType The operation to perform on the speciﬁed form. Type: String Response Elements Welcome API Version 2021-08-11 240 AmplifyUIBuilder Welcome Valid Values: create \| update id The unique ID of the form. Type: String labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. schemaVersion The schema version of the form when it was imported. Type: String sectionalElements Stores the visual helper elements for the form that are not associated with any data. Type: String to SectionalElement object map style Stores the conﬁguration for the form's style. Type: FormStyle object tags One or more key-value pairs to use when tagging the form. Type: String to string map Response Elements API Version 2021-08-11 241 AmplifyUIBuilder Welcome Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceConﬂictException The resource speciﬁed in the request conﬂicts with an existing resource. HTTP Status Code: 409 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin Errors API Version 2021-08-11 242 AmplifyUIBuilder • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 243 AmplifyUIBuilder UpdateTheme Updates an existing theme. Request Syntax Welcome PATCH /app/appId/environment/environmentName/themes/id?clientToken=clientToken HTTP/1.1 Content-type: application/json { "id": "string", "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "values": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ] } URI Request Parameters The request uses the following URI parameters. UpdateTheme API Version 2021-08-11 244 Welcome AmplifyUIBuilder appId The unique ID for the Amplify app. Required: Yes clientToken The unique client token. environmentName The name of the backend environment that is part of the Amplify app. Required: Yes id The unique ID for the theme. Required: Yes Request Body The request accepts the following data in JSON format. id The unique ID of the theme to update. Type: String Required: No name The name of the theme to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No overrides Describes the properties that can be overriden to customize the theme. Request Body API Version 2021-08-11 245 AmplifyUIBuilder Welcome Type: Array of ThemeValues objects Required: No values A list of key-value pairs that deﬁne the theme's properties. Type: Array of ThemeValues objects Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "appId": "string", "createdAt": "string", "environmentName": "string", "id": "string", "modifiedAt": "string", "name": "string", "overrides": [ { "key": "string", "value": { "children": [ "ThemeValues" ], "value": "string" } } ], "tags": { "string" : "string" }, "values": [ { "key": "string", "value": { "children": [ Response Syntax API Version 2021-08-11 246 AmplifyUIBuilder Welcome "ThemeValues" ], "value": "string" } } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. appId The unique ID for the Amplify app associated with the theme. Type: String createdAt The time that the theme was created. Type: Timestamp environmentName The name of the backend environment that is a part of the Amplify app. Type: String id The ID for the theme. Type: String modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp name The name of the theme. Response Elements API Version 2021-08-11 247 AmplifyUIBuilder Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the properties that can be overriden to customize a theme. Type: Array of ThemeValues objects tags One or more key-value pairs to use when tagging the theme. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. values A list of key-value pairs that deﬁnes the properties
amplifyuibuilder-api-038	amplifyuibuilder-api.pdf	38	theme was modiﬁed. Type: Timestamp name The name of the theme. Response Elements API Version 2021-08-11 247 AmplifyUIBuilder Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. overrides Describes the properties that can be overriden to customize a theme. Type: Array of ThemeValues objects tags One or more key-value pairs to use when tagging the theme. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. values A list of key-value pairs that deﬁnes the properties of the theme. Type: Array of ThemeValues objects Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException An internal error has occurred. Please retry your request. HTTP Status Code: 500 InvalidParameterException An invalid or out-of-range value was supplied for the input parameter. HTTP Status Code: 400 ResourceConﬂictException The resource speciﬁed in the request conﬂicts with an existing resource. Errors API Version 2021-08-11 248 AmplifyUIBuilder HTTP Status Code: 409 See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2021-08-11 249 AmplifyUIBuilder Data Types Welcome The AWS Amplify UI Builder API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • ActionParameters • ApiConﬁguration • CodegenDependency • CodegenFeatureFlags • CodegenGenericDataEnum • CodegenGenericDataField • CodegenGenericDataModel • CodegenGenericDataNonModel • CodegenGenericDataRelationshipType • CodegenJob • CodegenJobAsset • CodegenJobGenericDataSchema • CodegenJobRenderConﬁg • CodegenJobSummary • Component • ComponentBindingPropertiesValue • ComponentBindingPropertiesValueProperties • ComponentChild • ComponentConditionProperty • ComponentDataConﬁguration API Version 2021-08-11 250 AmplifyUIBuilder • ComponentEvent • ComponentProperty • ComponentPropertyBindingProperties • ComponentSummary • ComponentVariant • CreateComponentData • CreateFormData • CreateThemeData • DataStoreRenderConﬁg • ExchangeCodeForTokenRequestBody • FieldConﬁg • FieldInputConﬁg • FieldPosition • FieldValidationConﬁguration • FileUploaderFieldConﬁg • Form • FormBindingElement • FormButton • FormCTA • FormDataTypeConﬁg • FormInputBindingPropertiesValue • FormInputBindingPropertiesValueProperties • FormInputValueProperty • FormInputValuePropertyBindingProperties • FormStyle • FormStyleConﬁg • FormSummary • GraphQLRenderConﬁg • MutationActionSetStateParameter • NoApiRenderConﬁg Welcome API Version 2021-08-11 251 AmplifyUIBuilder • Predicate • PutMetadataFlagBody • ReactStartCodegenJobData • RefreshTokenRequestBody • SectionalElement • SortProperty • StartCodegenJobData • Theme • ThemeSummary • ThemeValue • ThemeValues • UpdateComponentData • UpdateFormData • UpdateThemeData • ValueMapping • ValueMappings Welcome API Version 2021-08-11 252 AmplifyUIBuilder ActionParameters Welcome Represents the event action conﬁguration for an element of a Component or ComponentChild. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters deﬁnes the action that is performed when an event occurs on the component. Contents anchor The HTML anchor link to the location to open. Specify this value for a navigation action. Type: ComponentProperty object Required: No ﬁelds A dictionary of key-value pairs mapping Amplify Studio properties to ﬁelds in a data model. Use when the action performs an operation on an Amplify DataStore model. Type: String to ComponentProperty object map Required: No global Speciﬁes whether the user should be signed out globally. Specify this value for an auth sign out action. Type: ComponentProperty object Required: No id The unique ID of the component that the ActionParameters apply to. Type: ComponentProperty object Required: No ActionParameters API Version 2021-08-11 253 AmplifyUIBuilder model Welcome The name of the data model. Use when the action performs an operation on an Amplify DataStore model. Type: String Required: No state A key-value pair that speciﬁes the state property name and its initial value. Type: MutationActionSetStateParameter object Required: No target The element within the same component to modify when the action occurs. Type: ComponentProperty object Required: No type The type of navigation action. Valid values are url and anchor. This value is required for a navigation action. Type: ComponentProperty object Required: No url The URL to the location to open. Specify this value for a navigation action. Type: ComponentProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2021-08-11 254 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 255 AmplifyUIBuilder ApiConﬁguration Describes the API conﬁguration for a code generation job. Welcome Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or
amplifyuibuilder-api-039	amplifyuibuilder-api.pdf	39	to the location to open. Specify this value for a navigation action. Type: ComponentProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2021-08-11 254 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 255 AmplifyUIBuilder ApiConﬁguration Describes the API conﬁguration for a code generation job. Welcome Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. dataStoreConﬁg The conﬁguration for an application using DataStore APIs. Type: DataStoreRenderConﬁg object Required: No graphQLConﬁg The conﬁguration for an application using GraphQL APIs. Type: GraphQLRenderConﬁg object Required: No noApiConﬁg The conﬁguration for an application with no API being used. Type: NoApiRenderConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ ApiConﬁguration API Version 2021-08-11 256 AmplifyUIBuilder • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 257 AmplifyUIBuilder Welcome CodegenDependency Dependency package that may be required for the project code to run. Contents isSemVer Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning. Type: Boolean Required: No name Name of the dependency package. Type: String Required: No reason Indicates the reason to include the dependency package in your project code. Type: String Required: No supportedVersion Indicates the version of the supported dependency package. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CodegenDependency API Version 2021-08-11 258 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 259 AmplifyUIBuilder Welcome CodegenFeatureFlags Describes the feature ﬂags that you can specify for a code generation job. Contents isNonModelSupported Speciﬁes whether a code generation job supports non models. Type: Boolean Required: No isRelationshipSupported Specifes whether a code generation job supports data relationships. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenFeatureFlags API Version 2021-08-11 260 AmplifyUIBuilder Welcome CodegenGenericDataEnum Describes the enums in a generic data schema. Contents values The list of enum values in the generic data schema. Type: Array of strings Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenGenericDataEnum API Version 2021-08-11 261 AmplifyUIBuilder Welcome CodegenGenericDataField Describes a ﬁeld in a generic data schema. Contents dataType The data type for the generic data ﬁeld. Type: String Valid Values: ID \| String \| Int \| Float \| AWSDate \| AWSTime \| AWSDateTime \| AWSTimestamp \| AWSEmail \| AWSURL \| AWSIPAddress \| Boolean \| AWSJSON \| AWSPhone \| Enum \| Model \| NonModel Required: Yes dataTypeValue The value of the data type for the generic data ﬁeld. Type: String Required: Yes isArray Speciﬁes whether the generic data ﬁeld is an array. Type: Boolean Required: Yes readOnly Speciﬁes whether the generic data ﬁeld is read-only. Type: Boolean Required: Yes required Speciﬁes whether the generic data ﬁeld is required. CodegenGenericDataField API Version 2021-08-11 262 Welcome AmplifyUIBuilder Type: Boolean Required: Yes relationship The relationship of the generic data schema. Type: CodegenGenericDataRelationshipType object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 263 AmplifyUIBuilder Welcome CodegenGenericDataModel Describes a model in a generic data schema. Contents ﬁelds The ﬁelds in the generic data model. Type: String to CodegenGenericDataField object map Required: Yes primaryKeys The primary keys of the generic data model. Type: Array of strings Required: Yes isJoinTable Speciﬁes whether the generic data model is a join table. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenGenericDataModel API Version 2021-08-11 264 AmplifyUIBuilder Welcome CodegenGenericDataNonModel Describes a non-model in a generic data schema. Contents ﬁelds The ﬁelds in a generic data schema non model. Type: String to CodegenGenericDataField object map Required: Yes See Also For more information about using this API in one
amplifyuibuilder-api-040	amplifyuibuilder-api.pdf	40	strings Required: Yes isJoinTable Speciﬁes whether the generic data model is a join table. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenGenericDataModel API Version 2021-08-11 264 AmplifyUIBuilder Welcome CodegenGenericDataNonModel Describes a non-model in a generic data schema. Contents ﬁelds The ﬁelds in a generic data schema non model. Type: String to CodegenGenericDataField object map Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenGenericDataNonModel API Version 2021-08-11 265 AmplifyUIBuilder Welcome CodegenGenericDataRelationshipType Describes the relationship between generic data models. Contents relatedModelName The name of the related model in the data relationship. Type: String Required: Yes type The data relationship type. Type: String Valid Values: HAS_MANY \| HAS_ONE \| BELONGS_TO Required: Yes associatedFields The associated ﬁelds of the data relationship. Type: Array of strings Required: No belongsToFieldOnRelatedModel The value of the belongsTo ﬁeld on the related data model. Type: String Required: No canUnlinkAssociatedModel Speciﬁes whether the relationship can unlink the associated model. Type: Boolean CodegenGenericDataRelationshipType API Version 2021-08-11 266 AmplifyUIBuilder Required: No isHasManyIndex Welcome Speciﬁes whether the @index directive is supported for a hasMany data relationship. Type: Boolean Required: No relatedJoinFieldName The name of the related join ﬁeld in the data relationship. Type: String Required: No relatedJoinTableName The name of the related join table in the data relationship. Type: String Required: No relatedModelFields The related model ﬁelds in the data relationship. Type: Array of strings Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 267 AmplifyUIBuilder CodegenJob Welcome Describes the conﬁguration for a code generation job that is associated with an Amplify app. Contents appId The ID of the Amplify app associated with the code generation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment associated with the code generation job. Type: String Required: Yes id The unique ID for the code generation job. Type: String Required: Yes asset The CodegenJobAsset to use for the code generation job. Type: CodegenJobAsset object Required: No autoGenerateForms Speciﬁes whether to autogenerate forms in the code generation job. CodegenJob API Version 2021-08-11 268 Welcome AmplifyUIBuilder Type: Boolean Required: No createdAt The time that the code generation job was created. Type: Timestamp Required: No dependencies Lists the dependency packages that may be required for the project code to run. Type: Array of CodegenDependency objects Required: No features Describes the feature ﬂags that you can specify for a code generation job. Type: CodegenFeatureFlags object Required: No genericDataSchema Describes the data schema for a code generation job. Type: CodegenJobGenericDataSchema object Required: No modiﬁedAt The time that the code generation job was modiﬁed. Type: Timestamp Required: No renderConﬁg Describes the conﬁguration information for rendering the UI component associated with the code generation job. Contents API Version 2021-08-11 269 AmplifyUIBuilder Welcome Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No status The status of the code generation job. Type: String Valid Values: in_progress \| failed \| succeeded Required: No statusMessage The customized status message for the code generation job. Type: String Required: No tags One or more key-value pairs to use when tagging the code generation job. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2021-08-11 270 AmplifyUIBuilder • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 271 Welcome AmplifyUIBuilder CodegenJobAsset Describes an asset for a code generation job. Contents downloadUrl The URL to use to access the asset. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenJobAsset API Version 2021-08-11 272 AmplifyUIBuilder Welcome CodegenJobGenericDataSchema Describes the data schema for a code generation job. Contents dataSourceType The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.
amplifyuibuilder-api-041	amplifyuibuilder-api.pdf	41	2021-08-11 271 Welcome AmplifyUIBuilder CodegenJobAsset Describes an asset for a code generation job. Contents downloadUrl The URL to use to access the asset. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenJobAsset API Version 2021-08-11 272 AmplifyUIBuilder Welcome CodegenJobGenericDataSchema Describes the data schema for a code generation job. Contents dataSourceType The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore. Type: String Valid Values: DataStore Required: Yes enums The name of a CodegenGenericDataEnum. Type: String to CodegenGenericDataEnum object map Required: Yes models The name of a CodegenGenericDataModel. Type: String to CodegenGenericDataModel object map Required: Yes nonModels The name of a CodegenGenericDataNonModel. Type: String to CodegenGenericDataNonModel object map Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CodegenJobGenericDataSchema API Version 2021-08-11 273 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 274 AmplifyUIBuilder Welcome CodegenJobRenderConﬁg Describes the conﬁguration information for rendering the UI component associated with the code generation job. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. react The name of the ReactStartCodegenJobData object. Type: ReactStartCodegenJobData object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CodegenJobRenderConﬁg API Version 2021-08-11 275 AmplifyUIBuilder Welcome CodegenJobSummary A summary of the basic information about the code generation job. Contents appId The unique ID of the Amplify app associated with the code generation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment associated with the code generation job. Type: String Required: Yes id The unique ID for the code generation job summary. Type: String Required: Yes createdAt The time that the code generation job summary was created. Type: Timestamp Required: No modiﬁedAt The time that the code generation job summary was modiﬁed. CodegenJobSummary API Version 2021-08-11 276 AmplifyUIBuilder Type: Timestamp Required: No See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 277 AmplifyUIBuilder Component Welcome Contains the conﬁguration settings for a user interface (UI) element for an Amplify app. A component is conﬁgured as a primary, stand-alone UI element. Use ComponentChild to conﬁgure an instance of a Component. A ComponentChild instance inherits the conﬁguration of the main Component. Contents appId The unique ID of the Amplify app associated with the component. Type: String Required: Yes bindingProperties The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties. Type: String to ComponentBindingPropertiesValue object map Required: Yes componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes createdAt The time that the component was created. Type: Timestamp Component API Version 2021-08-11 278 AmplifyUIBuilder Required: Yes environmentName Welcome The name of the backend environment that is a part of the Amplify app. Type: String Required: Yes id The unique ID of the component. Type: String Required: Yes name The name of the component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes overrides Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides. Type: String to string to string map map Required: Yes properties Describes the component's properties. You can't specify tags as a valid property for properties. Type: String to ComponentProperty object map Required: Yes Contents API Version 2021-08-11 279 AmplifyUIBuilder variants Welcome A list of the component's variants. A variant is a unique style conﬁguration of a main component. Type: Array of ComponentVariant objects Required: Yes children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects Required: No collectionProperties The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map Required: No events Describes the events that can be raised on the component. Use for the workﬂow feature in Amplify Studio that allows
amplifyuibuilder-api-042	amplifyuibuilder-api.pdf	42	API Version 2021-08-11 279 AmplifyUIBuilder variants Welcome A list of the component's variants. A variant is a unique style conﬁguration of a main component. Type: Array of ComponentVariant objects Required: Yes children A list of the component's ComponentChild instances. Type: Array of ComponentChild objects Required: No collectionProperties The data binding conﬁguration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties. Type: String to ComponentDataConﬁguration object map Required: No events Describes the events that can be raised on the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map Required: No modiﬁedAt The time that the component was modiﬁed. Type: Timestamp Required: No schemaVersion The schema version of the component when it was imported. Contents API Version 2021-08-11 280 AmplifyUIBuilder Type: String Required: No sourceId Welcome The unique ID of the component in its original source system, such as Figma. Type: String Required: No tags One or more key-value pairs to use when tagging the component. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 281 AmplifyUIBuilder Welcome ComponentBindingPropertiesValue Represents the data binding conﬁguration for a component at runtime. You can use ComponentBindingPropertiesValue to add exposed properties to a component to allow diﬀerent values to be entered when a component is reused in diﬀerent places in an app. Contents bindingProperties Describes the properties to customize with data at runtime. Type: ComponentBindingPropertiesValueProperties object Required: No defaultValue The default value of the property. Type: String Required: No type The property type. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComponentBindingPropertiesValue API Version 2021-08-11 282 AmplifyUIBuilder Welcome ComponentBindingPropertiesValueProperties Represents the data binding conﬁguration for a speciﬁc property using data stored in AWS. For AWS connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute. Contents bucket An Amazon S3 bucket. Type: String Required: No defaultValue The default value to assign to the property. Type: String Required: No ﬁeld The ﬁeld to bind the data to. Type: String Required: No key The storage key for an Amazon S3 bucket. Type: String Required: No model An Amplify DataStore model. Type: String ComponentBindingPropertiesValueProperties API Version 2021-08-11 283 AmplifyUIBuilder Required: No predicates A list of predicates for binding a component's properties to data. Welcome Type: Array of Predicate objects Required: No slotName The name of a component slot. Type: String Required: No userAttribute An authenticated user attribute. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 284 AmplifyUIBuilder ComponentChild A nested UI conﬁguration within a parent Component. Welcome Contents componentType The type of the child component. Type: String Required: Yes name The name of the child component. Type: String Required: Yes properties Describes the properties of the child component. You can't specify tags as a valid property for properties. Type: String to ComponentProperty object map Required: Yes children The list of ComponentChild instances for this component. Type: Array of ComponentChild objects Required: No events Describes the events that can be raised on the child component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map ComponentChild API Version 2021-08-11 285 AmplifyUIBuilder Required: No sourceId Welcome The unique ID of the child component in its original source system, such as Figma. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 286 AmplifyUIBuilder Welcome ComponentConditionProperty Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to diﬀerent values conditionally, based on the value of another property. Contents else The value to assign to the property if the condition is not met. Type: ComponentProperty object Required: No ﬁeld The name of a ﬁeld. Specify
amplifyuibuilder-api-043	amplifyuibuilder-api.pdf	43	Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 286 AmplifyUIBuilder Welcome ComponentConditionProperty Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to diﬀerent values conditionally, based on the value of another property. Contents else The value to assign to the property if the condition is not met. Type: ComponentProperty object Required: No ﬁeld The name of a ﬁeld. Specify this when the property is a data model. Type: String Required: No operand The value of the property to evaluate. Type: String Required: No operandType The type of the property to evaluate. Type: String Required: No operator The operator to use to perform the evaluation, such as eq to represent equals. Type: String ComponentConditionProperty API Version 2021-08-11 287 Welcome AmplifyUIBuilder Required: No property The name of the conditional property. Type: String Required: No then The value to assign to the property if the condition is met. Type: ComponentProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 288 AmplifyUIBuilder Welcome ComponentDataConﬁguration Describes the conﬁguration for binding a component's properties to data. Contents model The name of the data model to use to bind data to a component. Type: String Required: Yes identiﬁers A list of IDs to use to bind data to a component. Use this property to bind speciﬁcally chosen data, rather than data retrieved from a query. Type: Array of strings Required: No predicate Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection. Type: Predicate object Required: No sort Describes how to sort the component's properties. Type: Array of SortProperty objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ComponentDataConﬁguration API Version 2021-08-11 289 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 290 AmplifyUIBuilder ComponentEvent Welcome Describes the conﬁguration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event. Contents action The action to perform when a speciﬁc event is raised. Type: String Required: No bindingEvent Binds an event to an action on a component. When you specify a bindingEvent, the event is called when the action is performed. Type: String Required: No parameters Describes information about the action. Type: ActionParameters object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComponentEvent API Version 2021-08-11 291 AmplifyUIBuilder ComponentProperty Welcome Describes the conﬁguration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default. Contents bindingProperties The information to bind the component property to data at runtime. Type: ComponentPropertyBindingProperties object Required: No bindings The information to bind the component property to form data. Type: String to FormBindingElement object map Required: No collectionBindingProperties The information to bind the component property to data at runtime. Use this for collection components. Type: ComponentPropertyBindingProperties object Required: No componentName The name of the component that is aﬀected by an event. Type: String Required: No concat A list of component properties to concatenate to create the value to assign to this component property. ComponentProperty API Version 2021-08-11 292 AmplifyUIBuilder Welcome Type: Array of ComponentProperty objects Required: No condition The conditional expression to use to assign a value to the component property. Type: ComponentConditionProperty object Required: No conﬁgured Speciﬁes whether the user conﬁgured the property in Amplify Studio after importing it. Type: Boolean Required: No defaultValue The default value to assign to the component property. Type: String Required: No event An event that occurs in your app. Use this for workﬂow data binding. Type: String Required: No importedValue The default value assigned to the property when the component is imported into an app. Type: String Required: No model The data model to use to assign a value to the component property. Contents API Version 2021-08-11 293 AmplifyUIBuilder Type: String Required: No property The name of the component's property that is aﬀected by an event. Welcome Type: String Required: No type The component type. Type: String Required: No userAttribute An authenticated user attribute
amplifyuibuilder-api-044	amplifyuibuilder-api.pdf	44	the component property. Type: String Required: No event An event that occurs in your app. Use this for workﬂow data binding. Type: String Required: No importedValue The default value assigned to the property when the component is imported into an app. Type: String Required: No model The data model to use to assign a value to the component property. Contents API Version 2021-08-11 293 AmplifyUIBuilder Type: String Required: No property The name of the component's property that is aﬀected by an event. Welcome Type: String Required: No type The component type. Type: String Required: No userAttribute An authenticated user attribute to use to assign a value to the component property. Type: String Required: No value The value to assign to the component property. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 294 AmplifyUIBuilder Welcome See Also API Version 2021-08-11 295 AmplifyUIBuilder Welcome ComponentPropertyBindingProperties Associates a component property to a binding property. This enables exposed properties on the top level component to propagate data to the component's property values. Contents property The component property to bind to the data ﬁeld. Type: String Required: Yes ﬁeld The data ﬁeld to bind the property to. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComponentPropertyBindingProperties API Version 2021-08-11 296 AmplifyUIBuilder Welcome ComponentSummary Contains a summary of a component. This is a read-only data type that is returned by ListComponents. Contents appId The unique ID of the Amplify app associated with the component. Type: String Required: Yes componentType The component type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Type: String Required: Yes id The unique ID of the component. Type: String Required: Yes name The name of the component. Type: String ComponentSummary API Version 2021-08-11 297 AmplifyUIBuilder Welcome Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 298 AmplifyUIBuilder ComponentVariant Welcome Describes the style conﬁguration of a unique variation of a main component. Contents overrides The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides. Type: String to string to string map map Required: No variantValues The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues. Type: String to string map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ComponentVariant API Version 2021-08-11 299 AmplifyUIBuilder Welcome CreateComponentData Represents all of the information that is required to create a component. Contents bindingProperties The data binding information for the component's properties. Type: String to ComponentBindingPropertiesValue object map Required: Yes componentType The component type. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes name The name of the component Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes overrides Describes the component properties that can be overriden to customize an instance of the component. Type: String to string to string map map Required: Yes CreateComponentData API Version 2021-08-11 300 Welcome AmplifyUIBuilder properties Describes the component's properties. Type: String to ComponentProperty object map Required: Yes variants A list of the unique variants of this component. Type: Array of ComponentVariant objects Required: Yes children A list of child components that are instances of the main component. Type: Array of ComponentChild objects Required: No collectionProperties The data binding conﬁguration for customizing a component's properties. Use this for a collection component. Type: String to ComponentDataConﬁguration object map Required: No events The event conﬁguration for the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map Required: No schemaVersion The schema version of the component when it was imported. Type: String Contents API Version 2021-08-11 301 AmplifyUIBuilder Required: No sourceId Welcome The unique ID of the
amplifyuibuilder-api-045	amplifyuibuilder-api.pdf	45	components that are instances of the main component. Type: Array of ComponentChild objects Required: No collectionProperties The data binding conﬁguration for customizing a component's properties. Use this for a collection component. Type: String to ComponentDataConﬁguration object map Required: No events The event conﬁguration for the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. Type: String to ComponentEvent object map Required: No schemaVersion The schema version of the component when it was imported. Type: String Contents API Version 2021-08-11 301 AmplifyUIBuilder Required: No sourceId Welcome The unique ID of the component in its original source system, such as Figma. Type: String Required: No tags One or more key-value pairs to use when tagging the component data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 302 AmplifyUIBuilder CreateFormData Represents all of the information that is required to create a form. Welcome Contents dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: Yes ﬁelds The conﬁguration information for the form's ﬁelds. Type: String to FieldConﬁg object map Required: Yes formActionType Speciﬁes whether to perform a create or update action on the form. Type: String Valid Values: create \| update Required: Yes name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes schemaVersion The schema version of the form. CreateFormData API Version 2021-08-11 303 AmplifyUIBuilder Type: String Required: Yes sectionalElements Welcome The conﬁguration information for the visual helper elements for the form. These elements are not associated with any data. Type: String to SectionalElement object map Required: Yes style The conﬁguration for the form's style. Type: FormStyle object Required: Yes cta The FormCTA object that stores the call to action conﬁguration for the form. Type: FormCTA object Required: No labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none Required: No tags One or more key-value pairs to use when tagging the form data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Contents API Version 2021-08-11 304 AmplifyUIBuilder Welcome Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 305 AmplifyUIBuilder CreateThemeData Welcome Represents all of the information that is required to create a theme. Contents name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes values A list of key-value pairs that deﬁnes the properties of the theme. Type: Array of ThemeValues objects Required: Yes overrides Describes the properties that can be overriden to customize an instance of the theme. Type: Array of ThemeValues objects Required: No tags One or more key-value pairs to use when tagging the theme data. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No CreateThemeData API Version 2021-08-11 306 AmplifyUIBuilder See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 307 AmplifyUIBuilder Welcome DataStoreRenderConﬁg Describes the DataStore conﬁguration for an API for a code generation job. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataStoreRenderConﬁg API Version 2021-08-11 308 AmplifyUIBuilder Welcome ExchangeCodeForTokenRequestBody Describes the conﬁguration of a request to exchange an access code for a token. Contents code The access code to send in the request. Type: String Required: Yes redirectUri The location of the application that will receive the access code. Type: String Required: Yes clientId The ID of the client to request the token from. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see
amplifyuibuilder-api-046	amplifyuibuilder-api.pdf	46	AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataStoreRenderConﬁg API Version 2021-08-11 308 AmplifyUIBuilder Welcome ExchangeCodeForTokenRequestBody Describes the conﬁguration of a request to exchange an access code for a token. Contents code The access code to send in the request. Type: String Required: Yes redirectUri The location of the application that will receive the access code. Type: String Required: Yes clientId The ID of the client to request the token from. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExchangeCodeForTokenRequestBody API Version 2021-08-11 309 AmplifyUIBuilder FieldConﬁg Describes the conﬁguration information for a ﬁeld in a table. Welcome Contents excluded Speciﬁes whether to hide a ﬁeld. Type: Boolean Required: No inputType Describes the conﬁguration for the default input value to display for a ﬁeld. Type: FieldInputConﬁg object Required: No label The label for the ﬁeld. Type: String Required: No position Speciﬁes the ﬁeld position. Type: FieldPosition object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No validations The validations to perform on the value in the ﬁeld. Type: Array of FieldValidationConﬁguration objects FieldConﬁg API Version 2021-08-11 310 AmplifyUIBuilder Required: No See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 311 AmplifyUIBuilder FieldInputConﬁg Welcome Describes the conﬁguration for the default input values to display for a ﬁeld. Contents type The input type for the ﬁeld. Type: String Required: Yes defaultChecked Speciﬁes whether a ﬁeld has a default value. Type: Boolean Required: No defaultCountryCode The default country code for a phone number. Type: String Required: No defaultValue The default value for the ﬁeld. Type: String Required: No descriptiveText The text to display to describe the ﬁeld. Type: String Required: No FieldInputConﬁg API Version 2021-08-11 312 Welcome AmplifyUIBuilder ﬁleUploaderConﬁg The conﬁguration for the ﬁle uploader ﬁeld. Type: FileUploaderFieldConﬁg object Required: No isArray Speciﬁes whether to render the ﬁeld as an array. This property is ignored if the dataSourceType for the form is a Data Store. Type: Boolean Required: No maxValue The maximum value to display for the ﬁeld. Type: Float Required: No minValue The minimum value to display for the ﬁeld. Type: Float Required: No name The name of the ﬁeld. Type: String Required: No placeholder The text to display as a placeholder for the ﬁeld. Type: String Contents API Version 2021-08-11 313 Welcome AmplifyUIBuilder Required: No readOnly Speciﬁes a read only ﬁeld. Type: Boolean Required: No required Speciﬁes a ﬁeld that requires input. Type: Boolean Required: No step The stepping increment for a numeric value in a ﬁeld. Type: Float Required: No value The value for the ﬁeld. Type: String Required: No valueMappings The information to use to customize the input ﬁelds with data at runtime. Type: ValueMappings object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2021-08-11 314 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 315 AmplifyUIBuilder FieldPosition Describes the ﬁeld position. Contents Important Welcome This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. below The ﬁeld position is below the ﬁeld speciﬁed by the string. Type: String Required: No ﬁxed The ﬁeld position is ﬁxed and doesn't change in relation to other ﬁelds. Type: String Valid Values: first Required: No rightOf The ﬁeld position is to the right of the ﬁeld speciﬁed by the string. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: FieldPosition API Version 2021-08-11 316 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 317 AmplifyUIBuilder Welcome FieldValidationConﬁguration Describes the validation conﬁguration for a ﬁeld. Contents type The validation to perform on an object type. Type: String Required: Yes numValues The validation to perform on a number value. Type: Array of integers Required: No strValues The validation to perform on a string value. Type: Array of strings Required: No validationMessage The validation message to display. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ FieldValidationConﬁguration API Version 2021-08-11 318 AmplifyUIBuilder •
amplifyuibuilder-api-047	amplifyuibuilder-api.pdf	47	Also API Version 2021-08-11 317 AmplifyUIBuilder Welcome FieldValidationConﬁguration Describes the validation conﬁguration for a ﬁeld. Contents type The validation to perform on an object type. Type: String Required: Yes numValues The validation to perform on a number value. Type: Array of integers Required: No strValues The validation to perform on a string value. Type: Array of strings Required: No validationMessage The validation message to display. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ FieldValidationConﬁguration API Version 2021-08-11 318 AmplifyUIBuilder • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 319 AmplifyUIBuilder Welcome FileUploaderFieldConﬁg Describes the conﬁguration for the ﬁle uploader ﬁeld. Contents acceptedFileTypes The ﬁle types that are allowed to be uploaded by the ﬁle uploader. Provide this information in an array of strings specifying the valid ﬁle extensions. Type: Array of strings Required: Yes accessLevel The access level to assign to the uploaded ﬁles in the Amazon S3 bucket where they are stored. The valid values for this property are private, protected, or public. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation. Type: String Valid Values: public \| protected \| private Required: Yes isResumable Allows the ﬁle upload operation to be paused and resumed. The default value is false. When isResumable is set to true, the ﬁle uploader uses a multipart upload to break the ﬁles into chunks before upload. The progress of the upload isn't continuous, because the ﬁle uploader uploads a chunk at a time. Type: Boolean Required: No maxFileCount Speciﬁes the maximum number of ﬁles that can be selected to upload. The default value is an unlimited number of ﬁles. FileUploaderFieldConﬁg API Version 2021-08-11 320 AmplifyUIBuilder Type: Integer Required: No maxSize Welcome The maximum ﬁle size in bytes that the ﬁle uploader will accept. The default value is an unlimited ﬁle size. Type: Integer Required: No showThumbnails Speciﬁes whether to display or hide the image preview after selecting a ﬁle for upload. The default value is true to display the image preview. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 321 AmplifyUIBuilder Form Welcome Contains the conﬁguration settings for a Form user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default conﬁguration for the form. Contents appId The unique ID of the Amplify app associated with the form. Type: String Required: Yes dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Type: String Required: Yes ﬁelds Stores the information about the form's ﬁelds. Type: String to FieldConﬁg object map Required: Yes formActionType The operation to perform on the speciﬁed form. Type: String Form API Version 2021-08-11 322 AmplifyUIBuilder Welcome Valid Values: create \| update Required: Yes id The unique ID of the form. Type: String Required: Yes name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes schemaVersion The schema version of the form when it was imported. Type: String Required: Yes sectionalElements Stores the visual helper elements for the form that are not associated with any data. Type: String to SectionalElement object map Required: Yes style Stores the conﬁguration for the form's style. Type: FormStyle object Required: Yes cta Stores the call to action conﬁguration for the form. Contents API Version 2021-08-11 323 Welcome AmplifyUIBuilder Type: FormCTA object Required: No labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String Valid Values: required \| optional \| none Required: No tags One or more key-value pairs to use when tagging the form. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 324 AmplifyUIBuilder Welcome FormBindingElement Describes how to bind a component property to form data. Contents element The name of the component to retrieve a value from. Type: String Required: Yes property The property to retrieve a value from. Type: String Required: Yes
amplifyuibuilder-api-048	amplifyuibuilder-api.pdf	48	128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 324 AmplifyUIBuilder Welcome FormBindingElement Describes how to bind a component property to form data. Contents element The name of the component to retrieve a value from. Type: String Required: Yes property The property to retrieve a value from. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormBindingElement API Version 2021-08-11 325 AmplifyUIBuilder FormButton Welcome Describes the conﬁguration for a button UI element that is a part of a form. Contents children Describes the button's properties. Type: String Required: No excluded Speciﬁes whether the button is visible on the form. Type: Boolean Required: No position The position of the button. Type: FieldPosition object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormButton API Version 2021-08-11 326 AmplifyUIBuilder FormCTA Describes the call to action button conﬁguration for the form. Welcome Contents cancel Displays a cancel button. Type: FormButton object Required: No clear Displays a clear button. Type: FormButton object Required: No position The position of the button. Type: String Valid Values: top \| bottom \| top_and_bottom Required: No submit Displays a submit button. Type: FormButton object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: FormCTA API Version 2021-08-11 327 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 328 AmplifyUIBuilder Welcome FormDataTypeConﬁg Describes the data type conﬁguration for the data source associated with a form. Contents dataSourceType The data source type, either an Amplify DataStore model or a custom data type. Type: String Valid Values: DataStore \| Custom Required: Yes dataTypeName The unique name of the data type you are using as the data source for the form. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormDataTypeConﬁg API Version 2021-08-11 329 AmplifyUIBuilder Welcome FormInputBindingPropertiesValue Represents the data binding conﬁguration for a form's input ﬁelds at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow diﬀerent values to be entered when a form is reused in diﬀerent places in an app. Contents bindingProperties Describes the properties to customize with data at runtime. Type: FormInputBindingPropertiesValueProperties object Required: No type The property type. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormInputBindingPropertiesValue API Version 2021-08-11 330 AmplifyUIBuilder Welcome FormInputBindingPropertiesValueProperties Represents the data binding conﬁguration for a speciﬁc property using data stored in AWS. For AWS connected properties, you can bind a property to data stored in an Amplify DataStore model. Contents model An Amplify DataStore model. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormInputBindingPropertiesValueProperties API Version 2021-08-11 331 AmplifyUIBuilder Welcome FormInputValueProperty Describes the conﬁguration for an input ﬁeld on a form. Use FormInputValueProperty to specify the values to render or bind by default. Contents bindingProperties The information to bind ﬁelds to data at runtime. Type: FormInputValuePropertyBindingProperties object Required: No concat A list of form properties to concatenate to create the value to assign to this ﬁeld property. Type: Array of FormInputValueProperty objects Required: No value The value to assign to the input ﬁeld. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormInputValueProperty API Version 2021-08-11 332 AmplifyUIBuilder Welcome FormInputValuePropertyBindingProperties Associates a form property to a binding property. This enables exposed properties on the top level form to
amplifyuibuilder-api-049	amplifyuibuilder-api.pdf	49	concat A list of form properties to concatenate to create the value to assign to this ﬁeld property. Type: Array of FormInputValueProperty objects Required: No value The value to assign to the input ﬁeld. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormInputValueProperty API Version 2021-08-11 332 AmplifyUIBuilder Welcome FormInputValuePropertyBindingProperties Associates a form property to a binding property. This enables exposed properties on the top level form to propagate data to the form's property values. Contents property The form property to bind to the data ﬁeld. Type: String Required: Yes ﬁeld The data ﬁeld to bind the property to. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormInputValuePropertyBindingProperties API Version 2021-08-11 333 Welcome AmplifyUIBuilder FormStyle Describes the conﬁguration for the form's style. Contents horizontalGap The spacing for the horizontal gap. Type: FormStyleConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No outerPadding The size of the outer padding for the form. Type: FormStyleConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No verticalGap The spacing for the vertical gap. Type: FormStyleConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 FormStyle API Version 2021-08-11 334 AmplifyUIBuilder • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 335 AmplifyUIBuilder FormStyleConﬁg Describes the conﬁguration settings for the form's style properties. Welcome Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. tokenReference A reference to a design token to use to bind the form's style properties to an existing theme. Type: String Required: No value The value of the style setting. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FormStyleConﬁg API Version 2021-08-11 336 AmplifyUIBuilder FormSummary Describes the basic information about a form. Contents appId The unique ID for the app associated with the form summary. Welcome Type: String Required: Yes dataType The form's data source type. Type: FormDataTypeConﬁg object Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Type: String Required: Yes formActionType The type of operation to perform on the form. Type: String Valid Values: create \| update Required: Yes id The ID of the form. Type: String FormSummary API Version 2021-08-11 337 AmplifyUIBuilder Required: Yes name The name of the form. Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 338 AmplifyUIBuilder Welcome GraphQLRenderConﬁg Describes the GraphQL conﬁguration for an API for a code generation job. Contents fragmentsFilePath The path to the GraphQL fragments ﬁle, relative to the component output directory. Type: String Required: Yes mutationsFilePath The path to the GraphQL mutations ﬁle, relative to the component output directory. Type: String Required: Yes queriesFilePath The path to the GraphQL queries ﬁle, relative to the component output directory. Type: String Required: Yes subscriptionsFilePath The path to the GraphQL subscriptions ﬁle, relative to the component output directory. Type: String Required: Yes typesFilePath The path to the GraphQL types ﬁle, relative to the component output directory. Type: String Required: Yes GraphQLRenderConﬁg API Version 2021-08-11 339 AmplifyUIBuilder See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 340 AmplifyUIBuilder Welcome MutationActionSetStateParameter Represents the state conﬁguration when an action modiﬁes a property of another element within the same component. Contents componentName The name of the component that is being modiﬁed. Type: String Required: Yes property The name of the component property to apply the state conﬁguration to. Type: String Required: Yes set The state conﬁguration
amplifyuibuilder-api-050	amplifyuibuilder-api.pdf	50	AmplifyUIBuilder See Also Welcome For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 340 AmplifyUIBuilder Welcome MutationActionSetStateParameter Represents the state conﬁguration when an action modiﬁes a property of another element within the same component. Contents componentName The name of the component that is being modiﬁed. Type: String Required: Yes property The name of the component property to apply the state conﬁguration to. Type: String Required: Yes set The state conﬁguration to assign to the property. Type: ComponentProperty object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MutationActionSetStateParameter API Version 2021-08-11 341 AmplifyUIBuilder NoApiRenderConﬁg Welcome Describes the conﬁguration for an application with no API being used. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NoApiRenderConﬁg API Version 2021-08-11 342 AmplifyUIBuilder Predicate Welcome Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection. Contents and A list of predicates to combine logically. Type: Array of Predicate objects Required: No ﬁeld The ﬁeld to query. Type: String Required: No operand The value to use when performing the evaluation. Type: String Required: No operandType The type of value to use when performing the evaluation. Type: String Pattern: boolean\|string\|number Required: No operator The operator to use to perform the evaluation. Type: String Predicate API Version 2021-08-11 343 Welcome AmplifyUIBuilder Required: No or A list of predicates to combine logically. Type: Array of Predicate objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 344 AmplifyUIBuilder Welcome PutMetadataFlagBody Stores the metadata information about a feature on a form. Contents newValue The new information to store. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PutMetadataFlagBody API Version 2021-08-11 345 AmplifyUIBuilder Welcome ReactStartCodegenJobData Describes the code generation job conﬁguration for a React project. Contents apiConﬁguration The API conﬁguration for the code generation job. Type: ApiConﬁguration object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No dependencies Lists the dependency packages that may be required for the project code to run. Type: String to string map Required: No inlineSourceMap Speciﬁes whether the code generation job should render inline source maps. Type: Boolean Required: No module The JavaScript module type. Type: String Valid Values: es2020 \| esnext Required: No renderTypeDeclarations Speciﬁes whether the code generation job should render type declaration ﬁles. ReactStartCodegenJobData API Version 2021-08-11 346 Welcome AmplifyUIBuilder Type: Boolean Required: No script The ﬁle type to use for a JavaScript project. Type: String Valid Values: jsx \| tsx \| js Required: No target The ECMAScript speciﬁcation to use. Type: String Valid Values: es2015 \| es2020 Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 347 AmplifyUIBuilder Welcome RefreshTokenRequestBody Describes a refresh token. Contents token The token to use to refresh a previously issued access token that might have expired. Type: String Required: Yes clientId The ID of the client to request the token from. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RefreshTokenRequestBody API Version 2021-08-11 348 AmplifyUIBuilder SectionalElement Welcome Stores the conﬁguration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. Contents type The type of sectional element. Valid values are Heading, Text, and Divider. Type: String Required: Yes excluded Excludes a sectional element that was generated by default for a speciﬁed data model. Type: Boolean Required: No level Speciﬁes the size of the font for
amplifyuibuilder-api-051	amplifyuibuilder-api.pdf	51	• AWS SDK for Java V2 • AWS SDK for Ruby V3 RefreshTokenRequestBody API Version 2021-08-11 348 AmplifyUIBuilder SectionalElement Welcome Stores the conﬁguration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data. Contents type The type of sectional element. Valid values are Heading, Text, and Divider. Type: String Required: Yes excluded Excludes a sectional element that was generated by default for a speciﬁed data model. Type: Boolean Required: No level Speciﬁes the size of the font for a Heading sectional element. Valid values are 1 \| 2 \| 3 \| 4 \| 5 \| 6. Type: Integer Required: No orientation Speciﬁes the orientation for a Divider sectional element. Valid values are horizontal or vertical. Type: String Required: No position Speciﬁes the position of the text in a ﬁeld for a Text sectional element. SectionalElement API Version 2021-08-11 349 AmplifyUIBuilder Type: FieldPosition object Welcome Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No text The text for a Text sectional element. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 350 AmplifyUIBuilder SortProperty Describes how to sort the data that you bind to a component. Welcome Contents direction The direction of the sort, either ascending or descending. Type: String Valid Values: ASC \| DESC Required: Yes ﬁeld The ﬁeld to perform the sort on. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SortProperty API Version 2021-08-11 351 AmplifyUIBuilder Welcome StartCodegenJobData The code generation job resource conﬁguration. Contents renderConﬁg The code generation conﬁguration for the codegen job. Type: CodegenJobRenderConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes autoGenerateForms Speciﬁes whether to autogenerate forms in the code generation job. Type: Boolean Required: No features The feature ﬂags for a code generation job. Type: CodegenFeatureFlags object Required: No genericDataSchema The data schema to use for a code generation job. Type: CodegenJobGenericDataSchema object Required: No tags One or more key-value pairs to use when tagging the code generation job data. Type: String to string map StartCodegenJobData API Version 2021-08-11 352 AmplifyUIBuilder Welcome Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 353 AmplifyUIBuilder Theme Welcome A theme is a collection of style settings that apply globally to the components associated with an Amplify application. Contents appId The unique ID for the Amplify app associated with the theme. Type: String Required: Yes createdAt The time that the theme was created. Type: Timestamp Required: Yes environmentName The name of the backend environment that is a part of the Amplify app. Type: String Required: Yes id The ID for the theme. Type: String Required: Yes name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Theme API Version 2021-08-11 354 AmplifyUIBuilder Required: Yes values A list of key-value pairs that deﬁnes the properties of the theme. Welcome Type: Array of ThemeValues objects Required: Yes modiﬁedAt The time that the theme was modiﬁed. Type: Timestamp Required: No overrides Describes the properties that can be overriden to customize a theme. Type: Array of ThemeValues objects Required: No tags One or more key-value pairs to use when tagging the theme. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: (?!aws:)[a-zA-Z+-=._:/]+ Value Length Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2021-08-11 355 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 356 Welcome AmplifyUIBuilder ThemeSummary Describes the basic information about a theme. Contents appId The unique ID for the app associated with the theme summary. Type: String Required: Yes environmentName The name of the backend environment that is part of the
amplifyuibuilder-api-052	amplifyuibuilder-api.pdf	52	Constraints: Minimum length of 1. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2021-08-11 355 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 356 Welcome AmplifyUIBuilder ThemeSummary Describes the basic information about a theme. Contents appId The unique ID for the app associated with the theme summary. Type: String Required: Yes environmentName The name of the backend environment that is part of the Amplify app. Type: String Required: Yes id The ID of the theme. Type: String Required: Yes name The name of the theme. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ThemeSummary API Version 2021-08-11 357 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 358 Welcome AmplifyUIBuilder ThemeValue Describes the conﬁguration of a theme's properties. Contents children A list of key-value pairs that deﬁne the theme's properties. Type: Array of ThemeValues objects Required: No value The value of a theme property. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ThemeValue API Version 2021-08-11 359 AmplifyUIBuilder ThemeValues A key-value pair that deﬁnes a property of a theme. Welcome Contents key The name of the property. Type: String Required: No value The value of the property. Type: ThemeValue object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ThemeValues API Version 2021-08-11 360 AmplifyUIBuilder Welcome UpdateComponentData Updates and saves all of the information about a component, based on component ID. Contents bindingProperties The data binding information for the component's properties. Type: String to ComponentBindingPropertiesValue object map Required: No children The components that are instances of the main component. Type: Array of ComponentChild objects Required: No collectionProperties The conﬁguration for binding a component's properties to a data model. Use this for a collection component. Type: String to ComponentDataConﬁguration object map Required: No componentType The type of the component. This can be an Amplify custom UI component or another custom component. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No events The event conﬁguration for the component. Use for the workﬂow feature in Amplify Studio that allows you to bind events and actions to components. UpdateComponentData API Version 2021-08-11 361 AmplifyUIBuilder Welcome Type: String to ComponentEvent object map Required: No id The unique ID of the component to update. Type: String Required: No name The name of the component to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No overrides Describes the properties that can be overriden to customize the component. Type: String to string to string map map Required: No properties Describes the component's properties. Type: String to ComponentProperty object map Required: No schemaVersion The schema version of the component when it was imported. Type: String Required: No sourceId The unique ID of the component in its original source system, such as Figma. Contents API Version 2021-08-11 362 AmplifyUIBuilder Type: String Required: No variants Welcome A list of the unique variants of the main component being updated. Type: Array of ComponentVariant objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2021-08-11 363 AmplifyUIBuilder UpdateFormData Welcome Updates and saves all of the information about a form, based on form ID. Contents cta The FormCTA object that stores the call to action conﬁguration for the form. Type: FormCTA object Required: No dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: No ﬁelds The conﬁguration information for the form's ﬁelds. Type: String to FieldConﬁg object map Required: No formActionType Speciﬁes whether to perform a create or update action on the form. Type: String Valid Values: create \| update Required: No labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String UpdateFormData API Version 2021-08-11 364 AmplifyUIBuilder Welcome Valid Values: required \| optional \| none Required: No name The name of the form. Type: String Length Constraints: Minimum length of 1.
amplifyuibuilder-api-053	amplifyuibuilder-api.pdf	53	Required: No dataType The type of data source to use to create the form. Type: FormDataTypeConﬁg object Required: No ﬁelds The conﬁguration information for the form's ﬁelds. Type: String to FieldConﬁg object map Required: No formActionType Speciﬁes whether to perform a create or update action on the form. Type: String Valid Values: create \| update Required: No labelDecorator Speciﬁes an icon or decoration to display on the form. Type: String UpdateFormData API Version 2021-08-11 364 AmplifyUIBuilder Welcome Valid Values: required \| optional \| none Required: No name The name of the form. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No schemaVersion The schema version of the form. Type: String Required: No sectionalElements The conﬁguration information for the visual helper elements for the form. These elements are not associated with any data. Type: String to SectionalElement object map Required: No style The conﬁguration for the form's style. Type: FormStyle object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2021-08-11 365 AmplifyUIBuilder • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 366 Welcome AmplifyUIBuilder UpdateThemeData Saves the data binding information for a theme. Contents values A list of key-value pairs that deﬁne the theme's properties. Type: Array of ThemeValues objects Required: Yes id The unique ID of the theme to update. Type: String Required: No name The name of the theme to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No overrides Describes the properties that can be overriden to customize the theme. Type: Array of ThemeValues objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: UpdateThemeData API Version 2021-08-11 367 AmplifyUIBuilder • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2021-08-11 368 AmplifyUIBuilder ValueMapping Welcome Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed. Contents value The complex object. Type: FormInputValueProperty object Required: Yes displayValue The value to display for the complex object. Type: FormInputValueProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValueMapping API Version 2021-08-11 369 AmplifyUIBuilder ValueMappings Represents the data binding conﬁguration for a value map. Welcome Contents values The value and display value pairs. Type: Array of ValueMapping objects Required: Yes bindingProperties The information to bind ﬁelds to data at runtime. Type: String to FormInputBindingPropertiesValue object map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValueMappings API Version 2021-08-11 370 AmplifyUIBuilder Welcome Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2021-08-11 371 AmplifyUIBuilder Welcome For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header.
amplifyuibuilder-api-054	amplifyuibuilder-api.pdf	54	parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2021-08-11 372 AmplifyUIBuilder Type: string Required: Conditional X-Amz-SignedHeaders Welcome Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2021-08-11 373 AmplifyUIBuilder Welcome Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2021-08-11 374 AmplifyUIBuilder HTTP Status Code: 403 RequestAbortedException Welcome Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2021-08-11 375 AmplifyUIBuilder UnknownOperationException Welcome The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2021-08-11 376
ams-appguide-001	ams-appguide.pdf	1	AMS Advanced Application Deployment Options AMS Advanced Application Developer's Guide Version September 13, 2024 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS Advanced Application Developer's Guide: AMS Advanced Application Deployment Options Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Table of Contents Application onboarding .................................................................................................................. 1 What is application onboarding? .............................................................................................................. 1 What we do, what we do not do .............................................................................................................. 2 AMS Amazon Machine Images (AMIs) ...................................................................................................... 3 Security enhanced AMIs ......................................................................................................................... 6 Key terms ....................................................................................................................................................... 6 What is my operating model? ................................................................................................................. 12 Service management ..................................................................................................................... 14 Account governance ................................................................................................................................... 14 Service commencement ............................................................................................................................ 15 Customer relationship management (CRM) .......................................................................................... 15 CRM Process ........................................................................................................................................... 16 CRM meetings ........................................................................................................................................ 17 CRM Meeting Arrangements ............................................................................................................... 18 CRM monthly reports ........................................................................................................................... 19 Cost optimization ....................................................................................................................................... 20 Cost optimization framework ............................................................................................................. 20 Cost optimization responsibility matrix ........................................................................................... 22 Service hours ............................................................................................................................................... 24 Getting help ................................................................................................................................................ 25 Application development .............................................................................................................. 26 Being well-architected .............................................................................................................................. 27 Application layer vs infrastructure layer responsibilities ................................................................... 28 EC2 instance mutability ............................................................................................................................ 28 Using AWS Secrets Manager with AMS resources ............................................................................... 29 Application deployment in AMS ................................................................................................... 30 Application deployment capabilities ...................................................................................................... 30 Planning your application deployment ................................................................................................. 34 AMS Workload Ingest (WIGS) .................................................................................................................. 34 Migrating Workloads: Prerequisites for Linux and Windows ....................................................... 35 How Migration Changes Your Resource ........................................................................................... 39 Migrating Workloads: Standard Process .......................................................................................... 40 Migrating workloads: CloudEndure landing zone (SALZ) ............................................................. 42 Tools account (migrating workloads) ............................................................................................... 45 Version September 13, 2024 iii AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Migrating workloads: Linux pre-ingestion validation .................................................................... 54 Migrating workloads: Windows pre-ingestion validation ............................................................. 56 Workload Ingest Stack: Creating ....................................................................................................... 60 AMS CloudFormation ingest .................................................................................................................... 65 AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations ................................. 66 AWS CloudFormation Ingest: Examples ........................................................................................... 86 Create CloudFormation ingest stack ................................................................................................. 93 Update AWS CloudFormation ingest stack ..................................................................................... 99 Approve a CloudFormation ingest stack changeset .................................................................... 104 Update AWS CloudFormation stacks termination protection ................................................... 106 Automated IAM deployments using CFN ingest or stack update CTs ...................................... 110 CodeDeploy requests .............................................................................................................................. 115 CodeDeploy application .................................................................................................................... 116 CodeDeploy deployment groups ..................................................................................................... 123 AWS Database Migration Service (AWS DMS) .................................................................................... 130 Planning for AWS DMS ..................................................................................................................... 131 Required data for AWS DMS setup ................................................................................................. 133 Tasks for AWS DMS setup ................................................................................................................ 133 Managing your AWS DMS ................................................................................................................. 166 Database (DB) import to AMS RDS for SQL Server .......................................................................... 173 Setting up ............................................................................................................................................ 174 Importing the database .................................................................................................................... 175 Cleanup ................................................................................................................................................. 176 Tier and Tie app deployments .............................................................................................................. 176 Full stack app deployments .................................................................................................................. 176 Working with provisioning change types (CTs) ................................................................................. 177 See if an existing CT meets your requirements ........................................................................... 177 Request a new CT .............................................................................................................................. 184 Test the new CT .................................................................................................................................. 185 Quick starts .................................................................................................................................. 186 AMS Resource Scheduler quick start ................................................................................................... 186 AMS Resource Scheduler terminology ........................................................................................... 186 AMS Resource Scheduler implementation .................................................................................... 187 Setting up cross account backups (intra-Region) .............................................................................. 190 Tutorials ....................................................................................................................................... 194 Console Tutorial: High Availability Two Tier Stack (Linux/RHEL) ................................................... 194 Version September 13, 2024 iv AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Before You Begin ................................................................................................................................ 195 Create the Infrastructure .................................................................................................................. 196 Create, Upload, and Deploy the Application ................................................................................ 199 Validate the Application Deployment ............................................................................................ 204 Tear Down the High Availability Deployment .............................................................................. 205 Console Tutorial: Deploying a Tier and Tie WordPress Website ..................................................... 206 Creating an RFC using the Console (Basics) .................................................................................. 207 Creating the Infrastructure ............................................................................................................... 208 Create a WordPress CodeDeploy Bundle ....................................................................................... 211 Deploy the WordPress Application Bundle with CodeDeploy ................................................... 215 Validate the Application Deployment ............................................................................................ 218 Tear Down the Application Deployment ....................................................................................... 218 CLI Tutorial: High Availability Two-Tier Stack (Linux/RHEL) ........................................................... 218 Before You Begin ................................................................................................................................ 219 Create the Infrastructure .................................................................................................................. 220 Create, Upload, and Deploy the Application ................................................................................ 225 Validate the Application Deployment ............................................................................................ 231 Tear Down the Application Deployment ....................................................................................... 231 CLI Tutorial: Deploying a Tier and Tie WordPress Website ............................................................. 234 Creating an RFC using the CLI ......................................................................................................... 235 Create the Infrastructure .................................................................................................................. 235 Create a WordPress Application Bundle for CodeDeploy ........................................................... 235 Deploy the WordPress Application Bundle with CodeDeploy ................................................... 239 Validate the Application Deployment ............................................................................................ 245 Tear Down the Application Deployment ....................................................................................... 245 Application maintenance ............................................................................................................ 249 Application maintenance strategies ..................................................................................................... 249 Mutable deployment with a CodeDeploy-enabled AMI ................................................................... 250
ams-appguide-002	ams-appguide.pdf	2	................................................................................................................................ 219 Create the Infrastructure .................................................................................................................. 220 Create, Upload, and Deploy the Application ................................................................................ 225 Validate the Application Deployment ............................................................................................ 231 Tear Down the Application Deployment ....................................................................................... 231 CLI Tutorial: Deploying a Tier and Tie WordPress Website ............................................................. 234 Creating an RFC using the CLI ......................................................................................................... 235 Create the Infrastructure .................................................................................................................. 235 Create a WordPress Application Bundle for CodeDeploy ........................................................... 235 Deploy the WordPress Application Bundle with CodeDeploy ................................................... 239 Validate the Application Deployment ............................................................................................ 245 Tear Down the Application Deployment ....................................................................................... 245 Application maintenance ............................................................................................................ 249 Application maintenance strategies ..................................................................................................... 249 Mutable deployment with a CodeDeploy-enabled AMI ................................................................... 250 Mutable deployment, manually conﬁgured and updated application instances ........................ 251 Mutable deployment with a pull-based deployment tool-conﬁgured AMI .................................. 253 Mutable deployment with a push-based deployment tool-conﬁgured AMI ................................ 254 Immutable deployment with a golden AMI ....................................................................................... 255 Update Strategies .................................................................................................................................... 257 Resource Scheduler ................................................................................................................................. 257 Deploying Resource Scheduler ........................................................................................................ 258 Customizing Resource Scheduler .................................................................................................... 259 Version September 13, 2024 v AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Using Resource Scheduler ................................................................................................................. 259 AMS Resource Scheduler cost estimator ....................................................................................... 260 AMS Resource Scheduler best practices ........................................................................................ 261 Application security considerations ........................................................................................... 264 Access for conﬁguration management ................................................................................................ 264 Application access ﬁrewall rules ........................................................................................................... 264 Windows Instances .................................................................................................................................. 264 Parent Domain Controller, Windows .............................................................................................. 264 Child Domain Controller, Windows ................................................................................................. 265 Linux Instances .................................................................................................................................... 266 AMS egress traﬃc management .......................................................................................................... 268 Security groups ........................................................................................................................................ 269 Default Security Groups .................................................................................................................... 270 Create, Change, or Delete Security Groups ................................................................................... 273 Find Security Groups ......................................................................................................................... 273 Appendix: Application onboarding questionnaire ..................................................................... 274 Deployment summary ............................................................................................................................ 274 Infrastructure deployment components ............................................................................................. 274 Application hosting platform ................................................................................................................ 275 Application deployment model ............................................................................................................ 276 Application dependencies ...................................................................................................................... 276 SSL certiﬁcates for product applications ............................................................................................ 277 Document history ........................................................................................................................ 278 AWS Glossary ............................................................................................................................... 282 Version September 13, 2024 vi AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application onboarding Welcome to AWS Managed Services (AMS) AMS operations plan. The purpose of this document is to describe the various methods you can use when onboarding your applications to AMS once initial networking and access management has been set up, and the issues you should consider when choosing those methods. This document is intended for system integrators and application developers to assist in determining and crafting application processes for new AMS customers. What is application onboarding? AMS application onboarding refers to the deployment of resources and applications, as needed, into your AMS infrastructure. Architecting applications and infrastructure on the AMS platform is very similar to doing so on native AWS. Following AWS application and infrastructure design best practices while considering the capabilities that are provided by AMS will yield capable and operable applications hosted in the AMS environment. Note • US East (Virginia) • US West (N. California) • US West (Oregon) • US East (Ohio) • Canada (Central) • South America (São Paulo) • EU (Ireland) • EU (Frankfurt) • EU (London) • EU West (Paris) • Asia Paciﬁc (Mumbai) • Asia Paciﬁc (Seoul) • Asia Paciﬁc (Singapore) What is application onboarding? Version September 13, 2024 1 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Asia Paciﬁc (Sydney) • Asia Paciﬁc (Tokyo) New Regions are added frequently. To learn more, see AWS Regions and Availability Zones. What we do, what we do not do AMS gives you a standardized approach to deploying AWS infrastructure and provides the necessary ongoing operational management. For a full description of roles, responsibilities, and supported services, see Service Description. Note To request that AMS provide an additional AWS service, ﬁle a service request. For more information, see Making Service Requests. • What we do: After you complete onboarding, the AMS environment is available to receive requests for change (RFCs), incidents, and service requests. Your interaction with the AMS service revolves around the lifecycle of an application stack. New stacks are ordered from a preconﬁgured list of templates, launched into speciﬁc virtual private cloud (VPC) subnets, modiﬁed during their operational life through requests for change (RFCs), and monitored for events and incidents 24/7. Active application stacks are monitored and maintained by AMS, including patching, and require no further action for the life of the stack unless a change is required or the stack is decommissioned. Incidents detected by AMS that aﬀect the health and function of the stack generate a notiﬁcation and may or may not need your action to resolve or verify. How-to questions and other inquiries can be made by submitting a service request. Additionally, AMS allows you to enable compatible AWS services that are not managed by AMS. For information about AWS-AMS compatible services, see Self-service provisioning mode. • What we DON'T do: What we do, what we do not do Version September 13, 2024 2 AMS Advanced Application Developer's Guide AMS Advanced Application
ams-appguide-003	ams-appguide.pdf	3	change is required or the stack is decommissioned. Incidents detected by AMS that aﬀect the health and function of the stack generate a notiﬁcation and may or may not need your action to resolve or verify. How-to questions and other inquiries can be made by submitting a service request. Additionally, AMS allows you to enable compatible AWS services that are not managed by AMS. For information about AWS-AMS compatible services, see Self-service provisioning mode. • What we DON'T do: What we do, what we do not do Version September 13, 2024 2 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options While AMS simpliﬁes application deployment by providing a number of manual and automated options, you're responsible for the development, testing, updating, and management of your application. AMS provides troubleshooting assistance for infrastructure issues that impact applications, but AMS can't access or validate your application conﬁgurations. AMS Amazon Machine Images (AMIs) AMS produces updated Amazon Machine Images (AMIs) every month for AMS supported operating systems. In addition, AMS also produces security enhanced images (AMIs) based on CIS Level 1 benchmark for a subset of AMS's supported operating systems. To ﬁnd out which operating systems have a security enhanced image available, see the AMS Security User Guide, which is available through AWS Artifact -> Reports page (ﬁnd the Reports option in the left navigation pane) ﬁltered for AWS Managed Services. To access AWS Artifact, can contact your CSDM for instructions or go to Getting Started with AWS Artifact. To receive alerts when new AMS AMIs are released, you can subscribe to an Amazon Simple Notiﬁcation Service (Amazon SNS) notiﬁcation topic called "AMS AMI". For details, see AMS AMI notiﬁcations with SNS. The AMS AMI naming convention is: customer-ams-<operating system>-<release date> - <version>. (for example, customer-ams-rhel6-2018.11-3) Only use AMS AMIs that start with customer. AMS recommends always using the most recent AMI. You can ﬁnd the most recent AMIs by either: • Looking in the AMS console, on the AMIs page. • Viewing the latest AMS AMI CSV ﬁle, available from your CSDM or through this ZIP ﬁle: AMS 11.2024 AMI contents and CSV ﬁle in a ZIP. For past AMI ZIP ﬁles, see the Doc History. • Running this AMS SKMS command (AMS SKMS SDK required): aws amsskms list-amis --vpc-id VPC_ID --query "Amis.sort_by(@,&Name)[? starts_with(Name,'customer')].[Name,AmiId,CreationTime]" --output table AMS AMI content added to base AWS AMIs, by operating system (OS) AMS Amazon Machine Images (AMIs) Version September 13, 2024 3 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Linux AMIs: • AWS CLI Tools • NTP • Trend Micro Endpoint Protection Service Agent • Code Deploy • PBIS / Beyond Trust AD Bridge • SSM Agent • Yum Upgrade for critical patches • AMS custom scripts / management software (controlling boot, AD join, monitoring, security, and logging) • Windows Server AMIs: • Microsoft .NET Framework 4.5 • PowerShell 5.1 • AWS Tools for Windows PowerShell • AMS PowerShell Modules controlling boot, AD join, monitoring, security, and logging • Trend Micro Endpoint Protection Service Agent • SSM Agent • CloudWatch Agent • EC2Conﬁg service (through Windows Server 2012 R2) • EC2Launch (Windows Server 2016 and Windows Server 2019) • EC2LaunchV2 (Windows Server 2022 and later) Linux-based AMIs: • Amazon Linux 2023 (Latest Minor Release) (Minimal AMI not supported) • Amazon Linux 2 (Latest Minor Release) • Amazon Linux 2 (ARM64) • Red Hat Enterprise 7 (Latest Minor Release) • Red Hat Enterprise 8 (Latest Minor Release) • Red Hat Enterprise 9 (Latest Minor Release) AMS Amazon Machine Images (AMIs) • SUSE Linux Enterprise Server 15 SP5 Version September 13, 2024 4 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Ubuntu Linux 18.04 • Ubuntu Linux 20.04 • Ubuntu Linux 22.04 • Amazon Linux: For product overview, pricing information, usage information, and support information, see Amazon Linux AMI (HVM / 64-bit) and Amazon Linux 2. For more information, see Amazon Linux 2 FAQs. • RedHat Enterprise Linux (RHEL): For product overview, pricing information, usage information, and support information, see Red Hat Enterprise Linux (RHEL) 7 (HVM). • Ubuntu Linux 18.04: For product overview, pricing information, usage information, and support information, see Ubuntu 18.04 LTS - Bionic. • SUSE Linux Enterprise Server for SAP applications 15 SP5: • Run the following steps once per account: 1. Navigate to the AWS Marketplace. 2. Search for the SUSE 15 SAP product. 3. Choose Continue to subscribe. 4. Choose Accept terms. • Complete the following steps every time you need to launch a new SUSE Linux Enterprise Server for SAP Applications 15 SP5 instance: 1. Note the AMI ID for the subscribed SUSE Linux Enterprise Server for SAP Applications 15 AMI. 2. Create a manual (Management \| Other \| Other \| Create) RFC with the following wording; replace AMI ID with the
ams-appguide-004	ams-appguide.pdf	4	Linux Enterprise Server for SAP applications 15 SP5: • Run the following steps once per account: 1. Navigate to the AWS Marketplace. 2. Search for the SUSE 15 SAP product. 3. Choose Continue to subscribe. 4. Choose Accept terms. • Complete the following steps every time you need to launch a new SUSE Linux Enterprise Server for SAP Applications 15 SP5 instance: 1. Note the AMI ID for the subscribed SUSE Linux Enterprise Server for SAP Applications 15 AMI. 2. Create a manual (Management \| Other \| Other \| Create) RFC with the following wording; replace AMI ID with the AWS Marketplace AMI ID you have subscribed to. Windows-based AMIs: Microsoft Windows Server (2016, 2019 and 2022), based on latest Windows AMIs. For examples of creating AMIs, see Create AMI. Oﬀboarding AMS AMIs: AMS does not unshare any AMIs from you during oﬀboarding to avoid impact for any of your depedencies. If you want to remove AMS AMIs from your account, you can use the cancel- AMS Amazon Machine Images (AMIs) Version September 13, 2024 5 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options image-launch-permission API to hide speciﬁc AMIs. For example, you can use the script below to hide all of the AMS AMIs that were shared with your account earlier: for ami in $(aws ec2 describe-images --executable-users self --owners 027415890775 -- query 'Images[].ImageId' --output text) ; do aws ec2 cancel-image-launch-permission --image-id $ami ; done You must have the AWS CLI v2 installed for the script to execute without any errors. For AWS CLI installation steps, see Installing or updating the latest version of the AWS CLI. For details on the cancel-image-launch-permission command, see cancel-image-launch-permission. Security enhanced AMIs AMS provides security enhanced images (AMIs) based on CIS Level 1 benchmark for a subset of AMS's supported operating systems. To ﬁnd which operating systems have a security enhanced image available, see the AWS Managed Services (AMS) Customer Security Guide. To access this guide, open AWS Artifact, select Reports in the left navigation pane, and then ﬁlter for AWS Managed Services. For instructions on how to access AWS Artifact, contact your CSDM or see Getting Started with AWS Artifact for more information. AMS key terms • AMS Advanced: The services described in the "Service Description" section of the AMS Advanced Documentation. See Service Description. • AMS Advanced Accounts: AWS accounts that at all times meet all requirements in the AMS Advanced Onboarding Requirements. For information on AMS Advanced beneﬁts, case studies, and to contact a sales person, see AWS Managed Services. • AMS Accelerate Accounts: AWS accounts that at all times meet all requirements in the AMS Accelerate Onboarding Requirements. See Getting Started with AMS Accelerate. • AWS Managed Services: AMS and or AMS Accelerate. • AWS Managed Services accounts: The AMS accounts and or AMS Accelerate accounts. • Critical Recommendation: A recommendation issued by AWS through a service request informing you that your action is required to protect against potential risks or disruptions to your resources or the AWS services. If you decide not to follow a Critical Recommendation by the speciﬁed date, you are solely responsible for any harm resulting from your decision. Security enhanced AMIs Version September 13, 2024 6 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Customer-Requested Conﬁguration: Any software, services or other conﬁgurations that are not identiﬁed in: • Accelerate: Supported Conﬁgurations or AMS Accelerate; Service Description. • AMS Advanced: Supported Conﬁgurations or AMS Advanced; Service Description. • Incident communication: AMS communicates an Incident to you or you request an Incident with AMS via an Incident created in Support Center for AMS Accelerate and in the AMS Console for AMS. The AMS Accelerate Console provides a summary of Incidents and Service Requests on the Dashboard and links to Support Center for details. • Managed Environment: The AMS Advanced accounts and or the AMS Accelerate accounts operated by AMS. For AMS Advanced, these include multi-account landing zone (MALZ) and single-account landing zone (SALZ) accounts. • Billing start date: The next business day after AWS receives the your information requested in the AWS Managed Services Onboarding Email. The AWS Managed Services Onboarding Email refers to the email sent by AWS to the you to collect the information needed to activate AWS Managed Services on the your accounts. For accounts subsequently enrolled by you, the billing start date is the next business day after AWS Managed Services sends an AWS Managed Services Activation Notiﬁcation for the enrolled account. An AWS Managed Services Activation Notiﬁcation occurs when: 1. You grants access to a compatible AWS account and hand it over to AWS Managed Services. 2. AWS Managed Services designs and builds the AWS Managed Services Account. • Service Termination: You can terminate the AWS Managed Services for all AWS Managed Services accounts, or for
ams-appguide-005	ams-appguide.pdf	5	you to collect the information needed to activate AWS Managed Services on the your accounts. For accounts subsequently enrolled by you, the billing start date is the next business day after AWS Managed Services sends an AWS Managed Services Activation Notiﬁcation for the enrolled account. An AWS Managed Services Activation Notiﬁcation occurs when: 1. You grants access to a compatible AWS account and hand it over to AWS Managed Services. 2. AWS Managed Services designs and builds the AWS Managed Services Account. • Service Termination: You can terminate the AWS Managed Services for all AWS Managed Services accounts, or for a speciﬁed AWS Managed Services account for any reason by providing AWS at least 30 days notice through a service request. On the Service Termination Date, either: 1. AWS hands over the controls of all AWS Managed Services accounts or the speciﬁed AWS Managed Services accounts as applicable, to you, or 2. The parties remove the AWS Identity and Access Management roles that give AWS access from all AWS Managed Services accounts or the speciﬁed AWS Managed Services accounts, as applicable. • Service termination date: The service termination date is the last day of the calendar month following the end of the 30 days requisite termination notice period. If the end of the requisite termination notice period falls after the 20th day of the calendar month, then the service Key terms Version September 13, 2024 7 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options termination date is the last day of the following calendar month. The following are example scenarios for termination dates. • If the termination notice is provided on April 12, then the 30 days notice ends on May 12. The service termination date is May 31. • If a termination notice is provided on April 29, then the 30 days notice ends on May 29. The service termination date is June 30. • Provision of AWS Managed Services: AWS makes available to you and you can access and use AWS Managed Services for each AWS Managed Services account from the service commencement date. • Termination for speciﬁed AWS Managed Services accounts: You can terminate the AWS Managed Services for a speciﬁed AWS Managed Services account for any reason by providing AWS notice through a service request ("AMS Account Termination Request"). Incident management terms: • Event: A change in your AMS environment. • Alert: Whenever an event from a supported AWS service exceeds a threshold and triggers an alarm, an alert is created and notice is sent to your contacts list. Additionally, an incident is created in your Incident list. • Incident: An unplanned interruption or performance degradation of your AMS environment or AWS Managed Services that results in an impact as reported by AWS Managed Services or you. • Problem: A shared underlying root cause of one or more incidents. • Incident Resolution or Resolve an Incident: • AMS has restored all unavailable AMS services or resources pertaining to that incident to an available state, or • AMS has determined that unavailable stacks or resources cannot be restored to an available state, or • AMS has initiated an infrastructure restore authorized by you. • Incident Response Time: The diﬀerence in time between when you create an incident, and when AMS provides an initial response by way of the console, email, service center, or telephone. • Incident Resolution Time: The diﬀerence in time between when either AMS or you creates an incident, and when the incident is resolved. • Incident Priority: How incidents are prioritized by AMS, or by you, as either Low, Medium, or High. Key terms Version September 13, 2024 8 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Low: A non-critical problem with your AMS service. • Medium: An AWS service within your managed environment is available but is not performing as intended (per the applicable service description). • High: Either (1) the AMS Console, or one or more AMS APIs within your managed environment are unavailable; or (2) one or more AMS stacks or resources within your managed environment are unavailable and the unavailability prevents your application from performing its function. AMS may re-categorize incidents in accordance with the above guidelines. • Infrastructure Restore: Re-deploying existing stacks, based on templates of impacted stacks, and initiating a data restore based on the last known restore point, unless otherwise speciﬁed by you, when incident resolution is not possible. Infrastructure terms: • Managed production environment: A customer account where the customer’s production applications reside. • Managed non-production environment: A customer account that only contains non-production applications, such as applications for development and testing. • AMS stack: A group of one or more AWS resources that are managed by AMS as a single unit. • Immutable infrastructure: An infrastructure maintenance model typical for
ams-appguide-006	ams-appguide.pdf	6	above guidelines. • Infrastructure Restore: Re-deploying existing stacks, based on templates of impacted stacks, and initiating a data restore based on the last known restore point, unless otherwise speciﬁed by you, when incident resolution is not possible. Infrastructure terms: • Managed production environment: A customer account where the customer’s production applications reside. • Managed non-production environment: A customer account that only contains non-production applications, such as applications for development and testing. • AMS stack: A group of one or more AWS resources that are managed by AMS as a single unit. • Immutable infrastructure: An infrastructure maintenance model typical for Amazon EC2 Auto Scaling groups (ASGs) where updated infrastructure components, (in AWS, the AMI) are replaced for every deployment, rather than being updated in-place. The advantages to immutable infrastructure is that all components stay in a synchronous state since they are always generated from the same base. Immutability is independent of any tool or workﬂow for building the AMI. • Mutable infrastructure: An infrastructure maintenance model typical for stacks that are not Amazon EC2 Auto Scaling groups and contain a single instance or just a few instances. This model most closely represents traditional, hardware-based, system deployment where a system is deployed at the beginning of its life cycle and then updates are layered onto that system over time. Any updates to the system are applied to the instances individually, and may incur system downtime (depending on the stack conﬁguration) due to application or system restarts. • Security groups: Virtual ﬁrewalls for your instance to control inbound and outbound traﬃc. Security groups act at the instance level, not the subnet level. Therefore, each instance in a subnet in your VPC could have a diﬀerent set of security groups assigned to it. • Service Level Agreements (SLAs): Part of AMS contracts with you that deﬁne the level of expected service. Key terms Version September 13, 2024 9 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • SLA Unavailable and Unavailability: • An API request submitted by you that results in an error. • A Console request submitted by you that results in a 5xx HTTP response (the server is incapable of performing the request). • Any of the AWS service oﬀerings that constitute stacks or resources in your AMS-managed infrastructure are in a state of "Service Disruption" as shown in the Service Health Dashboard. • Unavailability resulting directly or indirectly from an AMS exclusion is not considered in determining eligibility for service credits. Services are considered available unless they meet the criteria for being unavailable. • Service Level Objectives (SLOs): Part of AMS contracts with you that deﬁne speciﬁc service goals for AMS services. Patching terms: • Mandatory patches: Critical security updates to address issues that could compromise the security state of your environment or account. A "Critical Security update" is a security update rated as "Critical" by the vendor of an AMS-supported operating system. • Patches announced versus released: Patches are generally announced and released on a schedule. Emergent patches are announced when the need for the patch has been discovered and, usually soon after, the patch is released. • Patch add-on: Tag-based patching for AMS instances that leverages AWS Systems Manager (SSM) functionality so you can tag instances and have those instances patched using a baseline and a window that you conﬁgure. • Patch methods: • In-place patching: Patching that is done by changing existing instances. • AMI replacement patching: Patching that is done by changing the AMI reference parameter of an existing EC2 Auto Scaling group launch conﬁguration. • Patch provider (OS vendors, third party): Patches are provided by the vendor or governing body of the application. • Patch Types: • Critical Security Update (CSU): A security update rated as "Critical" by the vendor of a supported operating system. • Important Update (IU): A security update rated as "Important" or a non-security update rated as "Critical" by the vendor of a supported operating system. Key terms Version September 13, 2024 10 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Other Update (OU): An update by the vendor of a supported operating system that is not a CSU or an IU. • Supported patches: AMS supports operating system level patches. Upgrades are released by the vendor to ﬁx security vulnerabilities or other bugs or to improve performance. For a list of currently supported OSs, see Support Conﬁgurations. Security terms: • Detective Controls: A library of AMS-created or enabled monitors that provide ongoing oversight of customer managed environments and workloads for conﬁgurations that do not align with security, operational, or customer controls, and take action by notifying owners, proactively modifying, or terminating resources. Service Request terms: • Service request: A request by you for an action that you want AMS to take on your behalf. •
ams-appguide-007	ams-appguide.pdf	7	supports operating system level patches. Upgrades are released by the vendor to ﬁx security vulnerabilities or other bugs or to improve performance. For a list of currently supported OSs, see Support Conﬁgurations. Security terms: • Detective Controls: A library of AMS-created or enabled monitors that provide ongoing oversight of customer managed environments and workloads for conﬁgurations that do not align with security, operational, or customer controls, and take action by notifying owners, proactively modifying, or terminating resources. Service Request terms: • Service request: A request by you for an action that you want AMS to take on your behalf. • Alert notiﬁcation: A notice posted by AMS to your Service requests list page when an AMS alert is triggered. The contact conﬁgured for your account is also notiﬁed by the conﬁgured method (for example, email). If you have contact tags on your instances/resources, and have provided consent to your cloud service delivery manager (CSDM) for tag-based notiﬁcations, the contact information (key value) in the tag is also notiﬁed for automated AMS alerts. • Service notiﬁcation: A notice from AMS that is posted to your Service request list page. Miscellaneous terms: • AWS Managed Services Interface: For AMS: The AWS Managed Services Advanced Console, AMS CM API, and Support API. For AMS Accelerate: The Support Console and Support API. • Customer satisfaction (CSAT): AMS CSAT is informed with deep analytics including Case Correspondence Ratings on every case or correspondence when given, quarterly surveys, and so forth. • DevOps: DevOps is a development methodology that strongly advocates automation and monitoring at all steps. DevOps aims at shorter development cycles, increased deployment frequency, and more dependable releases by bringing together the traditionally-separate functions of development and operations over a foundation of automation. When developers Key terms Version September 13, 2024 11 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options can manage operations, and operations informs development, issues and problems are more quickly discovered and solved, and business objectives are more readily achieved. • ITIL: Information Technology Infrastructure Library (called ITIL) is an ITSM framework designed to standardize the lifecycle of IT services. ITIL is arranged in ﬁve stages that cover the IT service lifecycle: service strategy, service design, service transition, service operation, and service improvement. • IT service management (ITSM): A set of practices that align IT services with the needs of your business. • Managed Monitoring Services (MMS): AMS operates its own monitoring system, Managed Monitoring Service (MMS), that consumes AWS Health events and aggregates Amazon CloudWatch data, and data from other AWS services, notifying AMS operators (online 24x7) of any alarms created through an Amazon Simple Notiﬁcation Service (Amazon SNS) topic. • Namespace: When you create IAM policies or work with Amazon Resource Names (ARNs), you identify an AWS service by using a namespace. You use namespaces when identifying actions and resources. What is my operating model? As an AMS customer, your organization has decided to separate application and infrastructure operations and use AMS for infrastructure operations. AMS will work with your application design and development team along with your infrastructure design team to ensure that your infrastructure operations run smoothly. The following graphic illustrates this concept: What is my operating model? Version September 13, 2024 12 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS takes responsibility for your AWS infrastructure operations while your teams are responsible for your application operations. As the application and infrastructure design teams, you must understand who will be operating the application once it has been deployed to production in the AMS infrastructure. This guide covers common approaches to infrastructure design as it relates to application deployment and maintenance. What is my operating model? Version September 13, 2024 13 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Service management in AWS Managed Services Topics • Account governance in AWS Managed Services • Service commencement in AWS Managed Services • Customer relationship management (CRM) • Cost optimization in AWS Managed Services • Service hours in AWS Managed Services • Getting help in AWS Managed Services How the AMS service works for you. Account governance in AWS Managed Services This section covers AMS account governance. You are designated a cloud service delivery manager (CSDM) who provides advisory assistance across AMS, and has a detailed understanding of your use case and technology architecture for the managed environment. CSDMs work with account managers, technical account managers, AWS Managed Services cloud architects (CAs), and AWS solution architects (SAs), as applicable, to help launch new projects and give best-practices recommendations throughout the software development and operations processes. The CSDM is the primary point of contact for AMS. Key responsibilities of your CSDM are: • Organize and lead monthly service review meetings with customers. • Provide details on security, software updates for environment and opportunities for
ams-appguide-008	ams-appguide.pdf	8	delivery manager (CSDM) who provides advisory assistance across AMS, and has a detailed understanding of your use case and technology architecture for the managed environment. CSDMs work with account managers, technical account managers, AWS Managed Services cloud architects (CAs), and AWS solution architects (SAs), as applicable, to help launch new projects and give best-practices recommendations throughout the software development and operations processes. The CSDM is the primary point of contact for AMS. Key responsibilities of your CSDM are: • Organize and lead monthly service review meetings with customers. • Provide details on security, software updates for environment and opportunities for optimization. • Champion your requirements including feature requests for AMS. • Respond to and resolve billing and service reporting requests. • Provide insights for ﬁnancial and capacity optimization recommendations. Account governance Version September 13, 2024 14 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Service commencement in AWS Managed Services Service Commencement: The Service Commencement Date for an AWS Managed Services account is the ﬁrst day of the ﬁrst calendar month after which AWS notiﬁes you that the activities set out in the Onboarding Requirements for that AWS Managed Services account have been completed; provided that if AWS makes such notiﬁcation after the 20th day of a calendar month, the Service Commencement Date is the ﬁrst day of the second calendar month following the date of such notiﬁcation. Service Commencement • R stands for responsible party that does the work to achieve the task. • I stands for informed; a party which is informed on progress, often only on completion of the task or deliverable. Service commencement Step # Step title Description CustomerAMS 1. 2. 3. Customer AWS account handover Customer creates a new AWS account and hands it over to AWS Managed Services AWS Managed Services Account Finalize design of AWS Managed Services Account - design AWS Managed Services Account - build An AWS Managed Services account is built per the design in Step 2 R I I I R R Customer relationship management (CRM) AWS Managed Services (AMS) provides a customer relationship management (CRM) process to ensure that a well-deﬁned relationship is established and maintained with you. The foundation of this relationship is based on AMS’s insight into your business requirements. The CRM process facilitates accurate and comprehensive understanding of: Service commencement Version September 13, 2024 15 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Your business needs and how to ﬁll those needs • Your capabilities and constraints • AMS and your diﬀerent responsibilities and obligations The CRM process allows AMS to use consistent methods to deliver services to you and provide governance for your relationship with AMS. The CRM process includes: • Identifying your key stakeholders • Establishing a governance team • Conducting and documenting service review meetings with you • Providing a formal service complaint procedure with an escalation procedure • Implementing and monitoring your satisfaction and feedback process • Managing your contract CRM Process The CRM process includes these activities: • Identifying and understanding your business processes and needs. Your agreement with AMS identiﬁes your stakeholders. • Deﬁning the services to be provided to meet your needs and requirements. • Meeting with you in the service review meetings to discuss any changes in the AMS service scope, SLA, contract, and your business needs. Interim meetings may be held with you to discuss performance, achievements, issues, and action plans. • Monitoring your satisfaction by using our customer satisfaction survey and feedback given at meetings. • Reporting performance on monthly internally-measured performance reports. • Reviewing the service with you to determine opportunities for improvements. This includes frequent communication with you regarding the level and quality of the AMS service provided. CRM Process Version September 13, 2024 16 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options CRM meetings AMS cloud service delivery managers (CSDMs) conduct meetings with you regularly to discuss service tracks (operations, security, and product innovations) and executive tracks (SLA reports, satisfaction measures, and changes in your business needs). Meeting Purpose Mode Participants Weekly status review (optional) Outstanding issues or incidents, patching, security events, problem records On-site customer location/ Telecom/Chime 12-week operational trend (+/- 6) Application operator concerns Weekend schedule AMS: CSDM and cloud architect (CA) Customer assigned team members (ex: Cloud/ Infrastructu re, Applicati on Support, Architecture teams, etc.) Monthly business review Review service level performance (reports, analysis, and trends) Financial analysis Product roadmap CSAT On-site customer location/ AMS: CSDM, cloud architect (CA), AMS Telecom/Chime account team, AMS technical product manager (TPM) (optional), AMS OPS manager (optional) You: Applicati on Operator representative CRM meetings Version September 13, 2024 17 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Meeting Purpose Mode Participants Quarterly business review Scorecard and service level agreement (SLA) performance and trends (6 months)
ams-appguide-009	ams-appguide.pdf	9	Weekend schedule AMS: CSDM and cloud architect (CA) Customer assigned team members (ex: Cloud/ Infrastructu re, Applicati on Support, Architecture teams, etc.) Monthly business review Review service level performance (reports, analysis, and trends) Financial analysis Product roadmap CSAT On-site customer location/ AMS: CSDM, cloud architect (CA), AMS Telecom/Chime account team, AMS technical product manager (TPM) (optional), AMS OPS manager (optional) You: Applicati on Operator representative CRM meetings Version September 13, 2024 17 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Meeting Purpose Mode Participants Quarterly business review Scorecard and service level agreement (SLA) performance and trends (6 months) On-site customer location Upcoming 3/6/9/12 months plans/ migrations Risk and risk mitigations Key improvement initiatives Product roadmap items Future direction aligned opportuni ties Financials Cost savings initiatives Business optimization AMS: CSDM, cloud architect , AMS account team, AMS service director, AMS operation manager You: Applicati on operator representative, service represent ative, service director CRM Meeting Arrangements The AMS CSDM is responsible for documenting the meeting, including: • Creating the agenda, including action items, issues, and list of attendees. • Creating the list of action items reviewed at each meeting to ensure items are completed and resolved on schedule. • Distributing meeting minutes and the action item list to meeting attendees by email within one business day after the meeting. • Storing meeting minutes in the appropriate document repository. In absence of the CSDM, the AMS representative leading the meeting creates and distributes minutes. CRM Meeting Arrangements Version September 13, 2024 18 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note Your CSDM works with you to establish your account governance. CRM monthly reports Your AMS CSDM prepares and sends out monthly service performance presentations. The presentations include information on the following: • Report date • Summary and Insights: • Key Call Outs: total and active stack count, stack patching status, account onboarding status (during onboarding only), customer-speciﬁc issues summaries • Performance: Stats on incident resolution, alerts, patching, requests for change (RFCs), service requests, and console and API availability • Issues, challenges, concerns, and risks: Customer-speciﬁc issues status • Upcoming items: Customer-speciﬁc onboarding or incident resolution plans • Managed Resources: Graphs and pie charts of stacks • AMS Metrics: Monitoring and event metrics, incident metrics, AMS SLA adherence metrics, service request metrics, change management metrics, storage metrics, continuity metrics, Trusted Advisor metrics, and cost summaries (presented several ways). Feature requests. Contact information. Note In addition to the described information, your CSDM also informs you of any material change in scope or terms, including use of subcontractors by AMS for operational activities. AMS generates reports about patching and backup that your CSDM includes in your monthly report. As part of the report generating system, AMS adds some infrastructure to your account that is not accessible to you: • An S3 Bucket, with the raw data reported • An Athena instance, with query deﬁnitions to query the data • A Glue Crawler to read the raw data from the S3 bucket CRM monthly reports Version September 13, 2024 19 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Cost optimization in AWS Managed Services AWS Managed Services provides a detailed cost utilization and savings reports every month to you during your monthly business reviews (MBRs). AMS follows a standard set of processes and mechanisms to identify cost saving avenues in your managed accounts and assist you to plan and roll-out the changes to optimize your AWS spend. Note AMS is developing a video to help with cost optimization. The ﬁrst step is providing you with a PDF and an Excel spreadsheet of cost optimization best practices. To access these resources, open the Quick guide to cost optimization ZIP ﬁle. Cost optimization framework AMS follows a three-staged approach with you to optimize your AWS costs: 1. Identify cost optimization avenues in your managed environment 2. Present a cost optimization plan to you 3. Assist in achieving cost optimization in a measurable way Identify cost optimization avenues in the managed environment AMS utilizes AWS native tools like Cost explorer, and Trusted Advisor while leveraging over 20 cost savings patterns across architecture optimization, EC2 instance, and AWS account-focused optimizations to build tailored cost savings recommendations for you. Some of the optimization recommendations include the following. Architectural optimization recommendations: • Optimal S3 storage class use: Amazon S3 oﬀers a range of storage classes to meet various workload requirements based on data access, resiliency, and cost. S3 Intelligent-Tiering and S3 storage class analysis based on the workload needs allow you to manage the S3 costs eﬃciently. • Using caching architectures: Leveraging cache instances, where applicable, can help you replace some database instances, while simultaneously meeting your IOPS requirements. Cost optimization Version September 13, 2024 20 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options
ams-appguide-010	ams-appguide.pdf	10	savings recommendations for you. Some of the optimization recommendations include the following. Architectural optimization recommendations: • Optimal S3 storage class use: Amazon S3 oﬀers a range of storage classes to meet various workload requirements based on data access, resiliency, and cost. S3 Intelligent-Tiering and S3 storage class analysis based on the workload needs allow you to manage the S3 costs eﬃciently. • Using caching architectures: Leveraging cache instances, where applicable, can help you replace some database instances, while simultaneously meeting your IOPS requirements. Cost optimization Version September 13, 2024 20 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • EBS upgrade savings: Migrating your EBS volumes from gp2 to gp3 provides a cost savings of up to 20% and you can take advantage of predictable 3,000 IOPS baseline performance and 125 MiB/s, regardless of volume size. • Using elasticity: The auto-scaling capabilities that AWS provides allow eﬀective resource utilization and avenues for cost optimization. Reviewing and updating the instance scaling policies regularly based on need, further provides cost savings. EC2 instance-focused recommendations • Instance rightsizing: Recommendations focused on sizing the instances and optimal conﬁgurations based on the usage. Recommendations also include utilizing Amazon EC2 Auto Scaling feature and replacing EC2 instances where applicable with AWS Lambda or static web content on Amazon S3, etc. • Instance scheduling: Using AMS Resource Scheduler to automatically start and stop instances based on a time schedule helps contain costs, especially for non-production instances that are not utilized during non-business hours. • Subscribing to Savings plans: Savings plan is the easiest way to save on AWS usage. The EC2 Instance Savings Plans oﬀer up to 72% savings compared to On-Demand pricing on your Amazon EC2 instances usage. The Amazon SageMaker AI Savings Plans oﬀer up to 64% savings on your Amazon SageMaker AI services usage. AMS provides appropriate recommendations on Savings plans based on your AWS resource usage. • Reserved instance (RI) usage and consumption guidance: Amazon EC2 Reserved Instances (RI) provide a signiﬁcant discount (up to 75%) compared to On-Demand pricing and provide a capacity reservation when used in a speciﬁc availability zone. • Spot instance usage: Fault tolerant workloads can utilize Spot instances and reduce prices up to 90%. • Idle instance termination: Identifying and reporting instances that are idle or have low utilization that can be terminated. Account-focused recommendations • Account cleanup: At an account level, AMS also identiﬁes un-utilized EBS volumes, duplicate CloudTrail trails, empty accounts with unused resources, and so forth, and provides recommendations for clean-up. Cost optimization framework Version September 13, 2024 21 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • SLA recommendations: Further, AMS regularly reviews your Plus and Premium accounts and recommends choosing the right SLA level for the accounts. • AMS automation optimization: AMS continuously optmizes AMS automation and infrastructure used to provide AMS services. Present to customers and assist in planning AMS conducts monthly business reviews (MBRs) with the key customer stakeholders and present the cost saving avenues, mechanisms and recommendations identiﬁed along with potential cost savings. We further work with you to plan the changes needed. Assist in recommendation implementation and measure the cost impact AMS assists in achieving and measuring cost impacts and optimization changes. You assess the application impact, risk and success criteria of the recommended changes, and raise the appropriate requests for change (RFCs) through the AMS console. AMS collaborates with you and implements the changes related to cost optimization in your managed accounts. AMS measures the cost impact and include the savings realised in the monthly business reviews (MBRs). Cost optimization responsibility matrix Responsibilities in AMS cost optimization. Cost optimization RACI Activity Customer Compiling cost I saving recommend ations and preparing the report Presentin g cost C AMS R R Cost optimization responsibility matrix Version September 13, 2024 22 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Activity Customer AMS R R R savings report Planning changes associate d with cost savings Assessing the change impact and risk Raising RFCs for implement ing the changes Reviewing the RFCs C and implement ing the changes C C C R Cost optimization responsibility matrix Version September 13, 2024 23 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS C R Activity Customer R Testing the applicati on and validatin g the change implement ation I Measuring the cost impact post change and presentin g to customer Service hours in AWS Managed Services Feature Service request Incident management (P2-P3) Backup and recovery Patch management Monitoring and alerting AMS Advanced Premium Tier 24/7 24/7 24/7 24/7 24/7 Service hours Version September 13, 2024 24 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Feature Automated request for change (RFC) Non-automated request for change (RFC) Cloud service delivery manager (CSDM) AMS Advanced Premium Tier 24/7
ams-appguide-011	ams-appguide.pdf	11	Advanced Application Deployment Options AMS C R Activity Customer R Testing the applicati on and validatin g the change implement ation I Measuring the cost impact post change and presentin g to customer Service hours in AWS Managed Services Feature Service request Incident management (P2-P3) Backup and recovery Patch management Monitoring and alerting AMS Advanced Premium Tier 24/7 24/7 24/7 24/7 24/7 Service hours Version September 13, 2024 24 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Feature Automated request for change (RFC) Non-automated request for change (RFC) Cloud service delivery manager (CSDM) AMS Advanced Premium Tier 24/7 24/7 Monday to Friday: 08:00– 17:00, local business hours Getting help in AWS Managed Services AMS supports you with Incident Management, Service Request Management, and Change Management 24 hours a day, 7 days a week, 365 days a year (in accordance with the AMS Service Level Agreement applied to the account). To report an AWS or AMS service performance issue that impacts your managed environment, use the AMS console and submit an incident report. For details, see Reporting an incident. For general information about AMS incident management, see Incident response. To ask for information or advice, or to request additional services from AMS, use the AMS console and submit a service request. For details, Creating a Service Request. For general information about AMS service requests, see Service Request Management. Getting help Version September 13, 2024 25 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application development Application development processes and practices that enable eﬀective design and deployment of applications into an AWS Managed Services (AMS) environment. AMS guides you through the following high level process: 1. Envision and architect an application to be developed or integrated to your AMS-managed environment. Some considerations: a. How will you deploy your application? With automation using a deployment tool such Ansible, or manually by directly uploading needed ﬁles? b. How will you update your application? With a mutable approach updating each instance separately, or with an immutable approach updating each instance with a single, updated, AMI in an Auto Scaling group? 2. Plan and architect the infrastructure that will be used to host the application using AWS architecture libraries, AWS "Well-Architected" guidance, and AMS and other cloud architecture subject matter experts. The following sections of this guide provide information that can help with this. 3. Select an infrastructure deployment approach: a. b. Full Stack: All infrastructure components are deployed at once, together. Tier and Tie: Infrastructure deployments are deployed separately and, after, tied together with security group modiﬁcations. This type of deployment is also achieved by a serial conﬁguration of stack components that builds upon each other; for example, specifying the load balancer that you previously created when you create an Auto Scaling group. c. What environments, such as Dev, Staging, and Prod, will you employ? 4. Choose AMS change types (CTs) that will provision the necessary stacks, or tiers, and prepare the necessary requests for change (RFCs). 5. Submit the RFCs to trigger the deployment of the infrastructure to the appropriate environment. 6. Deploy the application using the application deployment approach selected. 7. Re-work infrastructure and applications as needed. 8. Deploy infrastructure and applications to appropriate follow-on environments, assuming your ﬁrst deployment is to a non-production environment. Version September 13, 2024 26 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 9. Ongoing maintenance is handled by AMS operating the underlying infrastructure, and your operations teams operating the application(s) infrastructures. 10. To decommission an application, terminate the AMS infrastructure for it. Being well-architected At AWS we believe that well-architected systems greatly increase the likelihood of business success. The AWS Architecture Center provides expert guidance on architecting in the AWS Cloud. We recommend the following articles and whitepapers to help you understand the pros and cons of the decisions you must make while building systems on AWS. Are You Well-Architected?: Introduces the AWS Well-Architected Framework, based around six pillars: • Operational excellence: The operational excellence pillar focuses on running and monitoring systems to deliver business value, and continually improving processes and procedures. Key topics include managing and automating changes, responding to events, and deﬁning standards to successfully manage daily operations. • Security: The security pillar focuses on protecting information and systems. Key topics include conﬁdentiality and integrity of data, identifying and managing who can do what with permissions management, protecting systems, and establishing controls to detect security events. • Reliability: The reliability pillar focuses on the ability to prevent, and quickly recover from failures to meet business and customer demand. Key topics include foundational elements around setup, cross project requirements, recovery planning, and how we handle change. • Performance eﬃciency: The performance eﬃciency pillar focuses on using IT and computing resources eﬃciently. Key topics include selecting the right resource types and
ams-appguide-012	ams-appguide.pdf	12	Security: The security pillar focuses on protecting information and systems. Key topics include conﬁdentiality and integrity of data, identifying and managing who can do what with permissions management, protecting systems, and establishing controls to detect security events. • Reliability: The reliability pillar focuses on the ability to prevent, and quickly recover from failures to meet business and customer demand. Key topics include foundational elements around setup, cross project requirements, recovery planning, and how we handle change. • Performance eﬃciency: The performance eﬃciency pillar focuses on using IT and computing resources eﬃciently. Key topics include selecting the right resource types and sizes based on workload requirements, monitoring performance, and making informed decisions to maintain eﬃciency as business needs evolve. • Cost optimization: The cost optimization pillar focuses on avoiding unneeded costs. Key topics include understanding and controlling where money is being spent, selecting the most appropriate and right number of resource types, analyzing spend over time, and scaling to meet business needs without overspending. • Sustainability: The sustainability pillar focuses on the ability to continually improve sustainability impacts by reducing energy consumption and increasing eﬃciency across all Being well-architected Version September 13, 2024 27 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options components of a workload by maximizing the beneﬁts from the provisioned resources and minimizing the total resources required. AWS Well-Architected Framework: Describes how AWS enables customers to assess and improve their cloud-based architectures and better understand the business impact of their design decisions. It addresses general design principles as well as speciﬁc best practices and guidance in six conceptual areas that AWS deﬁnes as the pillars of the Well-Architected Framework. Application layer responsibilities vs infrastructure layer responsibilities in AMS By using AMS, your infrastructure, and all it needs for maintenance and growth, is maintained by AMS. However, whatever you need for line-of-business applications or product applications, is developed, deployed, and maintained by you. With the help of application deployment tools, such as CodeDeploy and AWS CloudFormation, or Chef, Puppet, Ansible, or Saltstack, your application deployment to your AMS-managed infrastructure can be fully automated. For details about what AMS does and does not do, see What we do, what we do not do. Amazon EC2 instance mutability in AMS You and AMS can maintain the Amazon Elastic Compute Cloud (Amazon EC2) instances in your infrastructure in one of two manners: • Immutable: This model uses Amazon Machine Images (AMIs) baked (created) with the necessary features. When deploying an update, the existing instances are torn down and completely replaced with new ones created from an updated AMI. To minimize down-time, this rolling process leaves some instances not updated and accessible while others are being updated until, eventually, the new change is completely deployed. • Mutable: In this model, the infrastructure is updated with new code being deployed on existing systems in the Cloud. This model is a mix of manually pushing updates and using infrastructure- as-code to deploy updates and does not rely on new AMIs. These maintenance models are discussed in more detail in later sections of this guide. Application layer vs infrastructure layer responsibilities Version September 13, 2024 28 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Using AWS Secrets Manager with AMS resources There are many cases where you may need to share secrets with AMS, for example: • Master password reset for RDS instance • Certiﬁcates for load balancers • Obtaining long-lived credentials for IAM users from AMS The safest way to share conﬁdential information with AMS is through the AWS Secrets Manager; follow these steps: 1. Login to the AWS Console using your federated access and the CustomerReadOnly role for single-account landing zone (SALZ); use any of these roles, AWSManagedServicesSecurityOpsRole, AWSManagedServicesAdminRole, and AWSManagedServicesChangeManagementRole for multi-account landing zone (MALZ). 2. Navigate to the AWS Secrets manager console and click Store a new secret. 3. Select "Other type of secrets". 4. Enter the secret value as a plain-text and click Next. 5. Enter the secret name and description. The name should always starts with "customer-shared/ *". For example "customer-shared/license-2018". Once you are done continue by clicking Next. 6. Use the default KMS encryption. 7. Leave automatic rotation disabled and click Next. 8. Review and click Store, to save the secret. 9. Reply to us in an AMS service request with the secret name and ARN, so we can identify and retrieve the secret. For information on creating service requests, see Service Request Examples. Using AWS Secrets Manager with AMS resources Version September 13, 2024 29 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application deployment in AMS During onboarding, AWS Managed Services (AMS) works with you to determine the infrastructure that you need. The basic infrastructure includes an AWS virtual private cloud (VPC), communication security via an ADFS forest trust, the basic
ams-appguide-013	ams-appguide.pdf	13	click Store, to save the secret. 9. Reply to us in an AMS service request with the secret name and ARN, so we can identify and retrieve the secret. For information on creating service requests, see Service Request Examples. Using AWS Secrets Manager with AMS resources Version September 13, 2024 29 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application deployment in AMS During onboarding, AWS Managed Services (AMS) works with you to determine the infrastructure that you need. The basic infrastructure includes an AWS virtual private cloud (VPC), communication security via an ADFS forest trust, the basic subnets (DMZ, Shared Services, and Private) mirrored across two availability zones and conﬁgured with a managed NAT, bastions, public load balancers, AWS Direct Connect (DX), and required security. Your application resources will be deployed in your private, or customer-applications, subnet. You can learn more about a typical AMS architecture in the AWS Managed Services User Guide. The infrastructure you deploy once the basics are done, should include all components for your applications and application development. Application deployment capabilities in AMS Some of the ways you can deploy applications in AMS. Details on each method follow. Application Deployment Capabilities Examples Method Name Infrastructure Deployment AMI or Key Element(s) Application Install Mutable Applications, AMS AMI Manual application deployment Full stack CT or Tier and Tie CTs AMS-provided AMI UserData applicati on deployment with application agent (i.e. Chef, Puppet, etc.) Submit Access management CT, install application manually. Use provisioning CT with UserData scripting that installs an application agent, and that script/agent installs the applicati on. Application deployment capabilities Version September 13, 2024 30 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Method Name Infrastructure Deployment AMI or Key Element(s) UserData agentless application deployment (i.e. Ansible, Salt SSH, etc.) Application Install Submit Access management CT, install applicati on agent. Deploy application with application deploy tooling. Mutable Applications, Custom AMI Custom AMI applicati on deployment (non- Full stack CT or Tier and Tie CTs Custom AMI. AMS AMI -> customize Application deploy tooling (i.e. Chef), ASG) with application leveraging agents, deploy tooling deploys application. AWS Database Migration Service AWS DMS sync to existing AMS (DMS) application Relational Database deployment stack. agent -> create EC2 instance (CT) -> create AMI (CT). Custom AMI Customer or partner employs AWS Database Migration Service; AMS veriﬁes AMS components on launch Application deployment capabilities Version September 13, 2024 31 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Method Name Infrastructure Deployment AMI or Key Element(s) Application Install Workload Ingest application deployment Partner-migrated instance/AMI and customer-initiated Workload Ingest CT. Partner migrates instance, creates AMI in customer AMS-managed VPC; customer uses Workload Ingest CT to launch stack in AMS. For details, see AMS Workload Ingest (WIGS). Immutable Applications Custom AMI applicati on deployment (ASG) Full stack CT or Tier and Tie CTs AMS AMI -> customize -> create Auto Scaling deploys application with the EC2 instance (CT) - custom AMI > create AMI (CT) -> create Auto Scaling group. For details, see Tier and Tie App Deployments in AMS. Mutable or Immutable Applications Application deployment capabilities Version September 13, 2024 32 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Method Name Infrastructure Deployment AMI or Key Element(s) Application Install Custom CloudForm ation Template CloudFormation template application deployment AWS CloudForm ation template -> customize/ AMS deploys your application to your account using your prepare for AMS custom CloudForm -> Deployment \| ation template, and Ingestion \| Stack validates the applicati from CloudFormation on deployment. Template \| Create (ct-36cn2avfrrj9v). For details, see AMS CloudFormation ingest. SQL Database Import AMS operations (Other \| Other CT) On premise SQL database -> .bak AMS imports your on-premises database ﬁle -> AMS RDS to your AMS-manag SQL database -> ed RDS database. For Management \| Other details, see Database \| Other \| Create (DB) import to AMS (ct-1e1xtak34nx76) RDS for Microsoft for the import. SQL Server. Database Migration Service (DMS) AMS operations (Multiple CTs) On premise database -> DMS replication AMS imports your on-premises database instance -> DMS to your AMS-manag replication subnet group -> DMS target endpoint -> DMS source endpoint -> ed S3 or target RDS database. For details, see AWS Database Migration Service DMS replication task. (AWS DMS). Application deployment capabilities Version September 13, 2024 33 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Method Name Infrastructure Deployment AMI or Key Element(s) Application Install CodeDeploy applicati on deployment CodeDeploy Application -> CodeDeploy applicati Depending on usage, In-place or Blue/ on -> CodeDeploy Green applicati deployment group on deployment. -> CodeDeploy For details, see deployment. CodeDeploy requests. Planning your application deployment in AMS For a recommended set of questions to be answered to enable application deployments, see Appendix: Application onboarding questionnaire. Questions cover describing your: • Deployment summary
ams-appguide-014	ams-appguide.pdf	14	AWS Database Migration Service DMS replication task. (AWS DMS). Application deployment capabilities Version September 13, 2024 33 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Method Name Infrastructure Deployment AMI or Key Element(s) Application Install CodeDeploy applicati on deployment CodeDeploy Application -> CodeDeploy applicati Depending on usage, In-place or Blue/ on -> CodeDeploy Green applicati deployment group on deployment. -> CodeDeploy For details, see deployment. CodeDeploy requests. Planning your application deployment in AMS For a recommended set of questions to be answered to enable application deployments, see Appendix: Application onboarding questionnaire. Questions cover describing your: • Deployment summary • Infrastructure deployment components • Application hosting platform • Application deployment model • Application dependencies • SSL certiﬁcates for product applications AMS Workload Ingest (WIGS) Topics • Migrating Workloads: Prerequisites for Linux and Windows • How Migration Changes Your Resource • Migrating Workloads: Standard Process • Migrating workloads: CloudEndure landing zone (SALZ) • AMS Tools account (migrating workloads) • Migrating workloads: Linux pre-ingestion validation • Migrating workloads: Windows pre-ingestion validation Planning your application deployment Version September 13, 2024 34 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Workload Ingest Stack: Creating Use the AMS workload ingest change type (CT) with an AMS cloud migration partner, to move your existing workloads into an AMS-managed VPC. Using AMS workload ingest, you can create a custom AMS AMI after moving migrated instances onto AMS. This section describes the process, pre-requisites, and steps that your migration partner and yourself take for AMS workload ingestion. Important The operating system must be supported by AMS workload ingest. For supported operating systems, see Migrating Workloads: Prerequisites for Linux and Windows. Every workload and account is diﬀerent. AMS will work with you to prepare for a successful result. The following diagram depicts the AMS workload ingestion process. Migrating Workloads: Prerequisites for Linux and Windows Before ingesting a copy of an on-premises instance into AWS Managed Services (AMS), certain prerequisites must be met. These are the prerequisites, including those that diﬀer between Windows and Linux operating systems. Migrating Workloads: Prerequisites for Linux and Windows Version September 13, 2024 35 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note To simplify the process of determining if the instances are ready for ingestion, validation tools for both Windows and Linux have been created. These tools can be downloaded and run directly on your on-premises servers as well as EC2 instances in AWS. Linux Pre-WIGS Validation.zip, Windows Pre-WIGS Validation.zip. BEFORE YOU BEGIN, for Linux and Windows: • Perform a full virus scan. • The instance must have the customer-mc-ec2-instance-profile instance proﬁle. • Install the Amazon EC2 Systems Manager (SSM) Agent and make sure that the SSM Agent is up and running. • A minimum of 10GB of free disk space on the root volume is recommended to run AMS workload ingest (WIGS). Operationally, AMS recommends disk utilization less than 75% and alerts when disk utilization reaches 85%. • Determine a time frame for the ingestion with your migration partner. • The custom AMI exists as an EC2 instance in the target production AMS account (this is the migration partner's responsibility). Important The operating system must be supported by AMS workload ingest. • The following operating systems are supported: • Microsoft Windows Server: 2008 R2, 2012, 2012 R2, 2016, 2019 and 2022 • Linux: Amazon Linux 2023, Amazon Linux 2, and Amazon Linux, CentOS 7.x, CentOS 6.5-6.10, Oracle Linux 7: minor versions 7.5 and above, Oracle Linux 8: minor versions up to 8.3, RHEL 8.x, RHEL 7.x, RHEL 6.5-6.10, SUSE Linux Enterprise Server 15 SP3, SP4, and SAP speciﬁc versions, SUSE Linux Enterprise Server 12 SP5, Ubuntu 18.04 • The following AMIs are not supported: • Amazon Linux 2023 Minimal AMI. Migrating Workloads: Prerequisites for Linux and Windows Version September 13, 2024 36 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note The AMS API/CLI (amscm and amsskms) endpoints are in the AWS N. Virginia Region, us-east-1. Depending on how your authentication is set, and what AWS Region your account and resources are in, you may need to add --region us-east-1 when issuing commands. You may also need to add --profile saml, if that is your authentication method. LINUX Prerequisites Observe the requirements listed in Migrating Workloads: Prerequisites for Linux and Windows and ensure the following before submitting a WIGS RFC: • The latest enhanced networking drivers are installed; see Enhanced Networking on Linux. • Third-party software components that will conﬂict with AMS components have been removed: • Anti-virus Clients • Backup Clients • Virtualization software (such as VM Tools or Hyper-V Integration services) • Access Management Software (Such as SSSD, Centrify, or PBIS) • Ensure SSH is properly conﬁgured - This temporarily enables private key authentication for SSH. AMS uses this with our conﬁguration management
ams-appguide-015	ams-appguide.pdf	15	authentication method. LINUX Prerequisites Observe the requirements listed in Migrating Workloads: Prerequisites for Linux and Windows and ensure the following before submitting a WIGS RFC: • The latest enhanced networking drivers are installed; see Enhanced Networking on Linux. • Third-party software components that will conﬂict with AMS components have been removed: • Anti-virus Clients • Backup Clients • Virtualization software (such as VM Tools or Hyper-V Integration services) • Access Management Software (Such as SSSD, Centrify, or PBIS) • Ensure SSH is properly conﬁgured - This temporarily enables private key authentication for SSH. AMS uses this with our conﬁguration management tool. Use these commands: sudo grep -q "^PubkeyAuthentication" /etc/ssh/sshd_config && sudo sed "s/ ^PubkeyAuthentication=./PubkeyAuthentication yes/" -i /etc/ssh/sshd_config \|\| sudo sed "$ a\PubkeyAuthentication yes" -i /etc/ssh/sshd_config sudo grep -q "^AuthorizedKeysFile" /etc/ssh/sshd_config && sudo sed "s/ ^AuthorizedKeysFile=./AuthorizedKeysFile %h\/.ssh\/authorized_keys/" -i /etc/ssh/ sshd_config \|\| sudo sed "$ a\AuthorizedKeysFile %h/.ssh/authorized_keys" -i /etc/ssh/ sshd_config • Ensure Yum is properly conﬁgured - RedHat requires licensing to use their Yum Repositories. The instance needs to be licensed via a Satellite Server or RedHat Cloud Server. Use one of these links if licensing is needed: • Red Hat Satellite • Red Hat Cloud Access Migrating Workloads: Prerequisites for Linux and Windows Version September 13, 2024 37 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • If you use Red Hat Satellite, WIGS requires the addition of Red Hat Software Collections (RHSCL). The WIGS system uses RHSCL to add a Python3.6 interpreter alongside whatever is conﬁgured on the system. To support this solution, the following repositories must be available: • rhel-server-rhscl • rhel-server-releases-optional Windows Prerequisites Observe the requirements listed in Migrating Workloads: Prerequisites for Linux and Windows and ensure the following before submitting a WIGS RFC: • Powershell version 3 or higher is installed. • AWS EC2 Conﬁg is installed on the instance with the workload that you will migrate. • Install the AWS drivers that support the latest generation instance types: PV, ENA, and NVMe. You can use the information in these links: • Upgrading PV Drivers on Your Windows Instances • Enhanced Networking on Windows • AWS NVMe Drivers for Windows Instances • Part 3: Upgrading AWS NVMe drivers • Part 5: Installing the Serial Port Driver for Bare Metal Instances • Part 6: Updating Power Management Settings • (Optional but recommended) Disable critical Services – Set critical application services, such as databases, to disabled, but ensure that any changes are documented so they can be reverted to their original startup mode during the application veriﬁcation stage. • (Optional but recommended) Create a Failsafe AMI from the prepared instance: • Use the Deployment \| Advanced stack components \| AMI \| Create • During creation, add a tag Key=Name, Value=APPLICATION-ID_IngestReady • Wait until AMI is created before proceeding • Third-party software components that will conﬂict with AMS components have been removed: • Anti-virus Clients • Backup Clients • Virtualization software (such as VM Tools or Hyper-V Integration services) Migrating Workloads: Prerequisites for Linux and Windows Version September 13, 2024 38 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note The End-of-Support Migration Program for Windows server (EMP) includes tooling to migrate your legacy applications from Windows Server 2003, 2008, and 2008 R2 to newer, supported versions on AWS, without any refactoring. How Migration Changes Your Resource The ingestion RFC described in this section takes the next step of adding conﬁgurations to the instance, once it is migrated to your AMS account, so that AMS can manage it. The conﬁgurations added are AMS-speciﬁc as follows. Changes made to ingested Linux instances: • Software that is installed: • Cloud Init: Used to conﬁgure private keys for Jarvis Access. • Python 3 (scripting language) for all supported operating systems (Except for CentOS 6, RHEL 8, OracleLinux 7). • AWS CloudFormation Python Helper Scripts: AWS CloudFormation provides scripts used to install software and start services on an Amazon EC2 instances. • AWS CLI: The AWS CLI is an open source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. • AWS SSM Agent: The SSM Agent processes requests from the Systems Manager service conﬁgures the machine as speciﬁed in the request. • AWS CloudWatch Logs Agent: Sends logs to CloudWatch. • AWS CodeDeploy: A deployment service that automates application deployments to Amazon EC2 instances, on-premises instances, or serverless Lambda functions. • Ruby: Required for CodeDeploy • System Performance Tools (sysstat): Sysstat contains various utilities to monitor system performance and usage activity. • AD Bridge (Formerly PowerBroker Identity Services): Joins non-Microsoft hosts to Active Directory domains. • Trend Micro Deep Security Agent: Anti-Virus software. • Software that is changed: How Migration Changes Your Resource Version September 13, 2024 39 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options •
ams-appguide-016	ams-appguide.pdf	16	the request. • AWS CloudWatch Logs Agent: Sends logs to CloudWatch. • AWS CodeDeploy: A deployment service that automates application deployments to Amazon EC2 instances, on-premises instances, or serverless Lambda functions. • Ruby: Required for CodeDeploy • System Performance Tools (sysstat): Sysstat contains various utilities to monitor system performance and usage activity. • AD Bridge (Formerly PowerBroker Identity Services): Joins non-Microsoft hosts to Active Directory domains. • Trend Micro Deep Security Agent: Anti-Virus software. • Software that is changed: How Migration Changes Your Resource Version September 13, 2024 39 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • The instances are conﬁgured to use the UTC timezone. Changes made to ingested Windows instances: • Software that is installed: • AWS Tools for Windows PowerShell: The AWS Tools for PowerShell let developers and administrators manage their AWS services and resources in the PowerShell scripting environment. • Trend Micro Deep Security Agent: Anti-Virus protection • AMS PowerShell Modules containing PowerShell code for controlling Boot, Active Directory Join, Monitoring, Security, and Logging. • Software that is changed: • Server Message Block (SMB) version 1 is disabled. • Windows Remote Management (WinRM) is enabled and conﬁgured to listen on port 5986. A ﬁrewall rule allowing this inbound port is also created. • Software that might be installed or changed: • Microsoft .Net Framework 4.5 (Developer platform), if a version lower then .Net Framework 4.5 is detected. • For Windows 2012, ad Windows 2012R2, we upgrade to PowerShell 5.1. Migrating Workloads: Standard Process Note Because two parties are required for this process, this section describes the tasks for each: an AMS Cloud Migration Partner (migration partner), and an Application Owner (you). Migrating Workloads: Standard Process Version September 13, 2024 40 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Migration partner, Set Up: a. The migration partner submits a Service Request to AMS for an IAM role for the purpose of migrating your instance. For details on submitting service requests, see Service Request Examples. b. The migration partner submits a Admin Access Request. The AMS Operations team provides the migration partner access to your account through the requested IAM role. 2. Migration partner, Migrate Individual Workloads: a. The migration partner migrates your non-AWS instance to a subnet in your AMS account through native Amazon EC2 or other migration tooling, with the customer-mc-ec2- instance-profile IAM instance proﬁle (must be in the account). b. The migration partner submits an RFC with the Deployment \| Ingestion \| Stack from migration partner migrated instance \| Create CT (ct-257p9zjk14ija); for details on creating and submitting this RFC, see Workload Ingest Stack: Creating. The execution output of the RFC returns an instance ID, IP address, and AMI ID. The migration partner provides you with the instance ID of the workload created in your account. 3. You, Access and Validate the Migration: a. Using the execution output provided you (AMI ID, instance ID, and IP address) by the migration partner, submit an access RFC and log into the newly-created AMS stack and Migrating Workloads: Standard Process Version September 13, 2024 41 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options verify that your application is working properly. For details, see Requesting Instance Access. b. If satisﬁed, you can continue to use the launched instance as a 1-tier stack and/or use the AMI to create additional stacks, including Auto Scaling groups. c. If not satisﬁed with the migration, ﬁle a service request and reference the stack and RFC IDs; AMS will work with you to address your concerns. CloudEndure landing zone workload ingest process is described next. Migrating workloads: CloudEndure landing zone (SALZ) This section provides information on setting up an intermediate migration single-account landing zone (SALZ) for CloudEndure (CE) cutover instances to be available for a workload ingest (WIGS) RFC. To learn more about CloudEndure, see CloudEndure Migration. Note This is a predeﬁned, security hardened, migration LZ and pattern. Prerequisites: • A customer AMS account • Network and access integration between AMS account and the customer on-premise • A CloudEndure account • A pre-approval workﬂow for an AMS Security review and signoﬀ, run with your CA and/or CSDM, (for example, misuse of the IAM user permanent credentials provides the ability to create/delete instances and security groups) Note Speciﬁc preparation and migration processes are described in this section. Migrating workloads: CloudEndure landing zone (SALZ) Version September 13, 2024 42 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Preparation: You and AMS operator: 1. Prepare a Request for Change (RFC) with the Management \| Other \| Other \| Update change type to AMS for the following resources and updates. You can submit separate Other \| Other Update RFCs, or one. For details on that RFC/CT, see Other \| Other Update with these requests: a. Assign a secondary
ams-appguide-017	ams-appguide.pdf	17	provides the ability to create/delete instances and security groups) Note Speciﬁc preparation and migration processes are described in this section. Migrating workloads: CloudEndure landing zone (SALZ) Version September 13, 2024 42 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Preparation: You and AMS operator: 1. Prepare a Request for Change (RFC) with the Management \| Other \| Other \| Update change type to AMS for the following resources and updates. You can submit separate Other \| Other Update RFCs, or one. For details on that RFC/CT, see Other \| Other Update with these requests: a. Assign a secondary CIDR block in your AMS VPC; a temporary CIDR block that will be removed after the migration is completed. Ensure that the block will not conﬂict with any existing routes back to your on-premise network. For example, if your AMS VPC CIDR is 10.0.0.0/16, and there is a route back to your on-premise netword of 10.1.0.0/16, then the temporary secondary CIDR could be 10.255.255.0/24. For information on AWS CIDR blocks, see VPC and Subnet Sizing. b. Create a new, private, subnet inside the initial-garden AMS VPC. Example name: migration-temp-subnet. c. Create a new route table for the subnet with only local VPC and NAT (Internet) routes, to avoid conﬂicts with the source server during instance cutover and possible outages. Ensure outbound traﬃc to the Internet is allowed for patch downloads, and so that AMS WIGS pre-requisites can be downloaded and installed. d. Update your Managed AD security group to allow inbound and outbound traﬃc to/from migration-temp-subnet. Also request that your EPS load balancer (ELB) security group Migrating workloads: CloudEndure landing zone (SALZ) Version September 13, 2024 43 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options (ex: mc-eps-McEpsElbPrivateSecurityGroup-M79OXBZEEX74) be updated to allow the new, private, subnet (i.e. migration-temp-subnet). If the traﬃc from the dedicated CloudEndure (CE) subnet is not allowed on all three TCP ports, WIGS ingestion will fail. e. Finally, request a new CloudEndure IAM policy and IAM user. The policy needs your correct account number, and the subnet IDs in the RunInstances statement should be: your <Customer Application Subnet(s) + Temp Migration Subnet>. To see an AMS pre-approved IAM CloudEndure policy: Unpack the WIGS Cloud Endure Landing Zone Example ﬁle and open the customer_cloud_endure_policy.json. Note If you want a more permissive policy, discuss what you need with your CloudArchitect/CSDM and obtain, if needed, an AMS Security Review and Signoﬀ before submitting an RFC implementing the policy. 2. Your preparation steps to use CloudEndure for AMS workload ingestion are done and, if your migration partner has completed their preparation steps, migration is ready to be performed. The WIGS RFC is submitted by your migration partner. Note IAM user keys won't be directly shared, but must be typed into the CloudEndure management console by the AMS operator in a screen-sharing session. Preparation: Migration Partner and AMS Operator: 1. Create CloudEndure migration project. a. During project creation, have AMS type-in IAM user credentials in screen-sharing sessions. b. c. In Replication Settings -> Choose the subnet where the Replication Servers will be launched, select customer-application-x subnet. In Replication Settings -> Choose the Security Groups to apply to the Replication Servers, select both Sentinel security groups (Private Only and EgressAll). 2. Deﬁne cutover options for the machines (instances). Migrating workloads: CloudEndure landing zone (SALZ) Version September 13, 2024 44 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options a. b. Subnet: migration-temp-subnet. Security Group: Both "Sentinel" security groups (Private Only and EgressAll). Cutover instances must be able to communicate to the AMS Managed AD and to AWS public endpoints. c. Elastic IP: None d. Public IP: no e. IAM role: customer-mc-ec2-instance-proﬁle The IAM role must allow for SSM communication. Better to use AMS default. f. Set tags as per convention. Migration: Migration Partner: 1. Create a dummy stack on AMS. You use the stack ID to gain access to the bastions. 2. Install the CloudEndure (CE) agent on the source server. For details, see Installing the Agents. 3. Create local admin credentials on the source server. 4. Schedule a short cutover window and click Cutover, when ready. This ﬁnalizes the migration and redirects users to the target AWS Region. 5. Request stack Admin access to the dummy stack, see Admin Access Request. 6. Log into the bastion, then to the cutover instance using the local admin credentials you created. 7. Create a failsafe AMI. For details on creating AMIs, see AMI Create. 8. Prepare the instance for ingestion, see Migrating Workloads: Prerequisites for Linux and Windows. 9. Run WIGS RFC against the instance, see Workload Ingest Stack: Creating. AMS Tools account (migrating workloads) Your Multi-Account Landing Zone tools account (with VPC) helps accelerate migration eﬀorts, increases your security position, reduces cost and complexity, and standardizes your usage pattern. A tools account
ams-appguide-018	ams-appguide.pdf	18	stack Admin access to the dummy stack, see Admin Access Request. 6. Log into the bastion, then to the cutover instance using the local admin credentials you created. 7. Create a failsafe AMI. For details on creating AMIs, see AMI Create. 8. Prepare the instance for ingestion, see Migrating Workloads: Prerequisites for Linux and Windows. 9. Run WIGS RFC against the instance, see Workload Ingest Stack: Creating. AMS Tools account (migrating workloads) Your Multi-Account Landing Zone tools account (with VPC) helps accelerate migration eﬀorts, increases your security position, reduces cost and complexity, and standardizes your usage pattern. A tools account provides the following: Tools account (migrating workloads) Version September 13, 2024 45 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • A well-deﬁned boundary for access to replication instances for system integrators outside of your production workloads. • Enables you to create an isolated chamber to check a workload for malware, or unknown network routes, before placing it into an account with other workloads. • As a deﬁned account setup, it provides faster time to onboard and get set up for migrating workloads. • Isolated network routes to secure traﬃc from on-premise -> CloudEndure -> Tools account -> AMS ingested image. Once an image has been ingested, you can share the image to the destination account via an AMS Management \| Advanced stack components \| AMI \| Share (ct-1eiczxw8ihc18) RFC. High level architecture diagram: Use the Deployment \| Managed landing zone \| Management account \| Create tools account (with VPC) change type (ct-2j7q1hgf26x5c), to quickly deploy a tools account and instantiate a Workload Tools account (migrating workloads) Version September 13, 2024 46 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Ingestion process within a Multi-Account Landing Zone environment. See Management account, Tools account: Creating (with VPC). Note We recommend having two availability zones (AZs), since this is a migration hub. By default, AMS creates the following two security groups (SGs) in every account. Conﬁrm the that the two SGs are present, and, if not, open a new Management \| Other \| Other \| Create CT (ct-1e1xtak34nx76) to request them: • SentinelDefaultSecurityGroupPrivateOnlyEgressAll • InitialGarden-SentinelDefaultSecurityGroupPrivateOnly Ensure that CloudEndure replication instances are created in the private subnet where there are routes back to on-premise. You can conﬁrm that by ensuring that the route tables for the private subnet has a default route back to TGW. However, performing a CloudEndure machine cut over should go into the "isolated" private subnet where there is no route back to on-premise, only Internet outbound traﬃc is allowed. It is critical to ensure cutover occurs in the isolated subnet to avoid potential issues to the on-premise resources. Prerequisites: 1. Either Plus or Premium support level. 2. The application account IDs for the KMS key where the AMIs are deployed. 3. The tools account, created as described previously. AWS Application Migration Service (AWS MGN) AWS Application Migration Service (AWS MGN) can be used in your MALZ Tools account through the AWSManagedServicesMigrationRole IAM role that is created automatically during Tools account provisioning. You can use AWS MGN to migrate applications and databases that run on supported versions of Windows and Linux operating systems. For the most up-to-date information on AWS Region support, see the AWS Regional Services List. Tools account (migrating workloads) Version September 13, 2024 47 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options If your preferred AWS Region is not currently supported by AWS MGN, or the operating system on which your applications run is not currently supported by AWS MGN, consider using the CloudEndure Migration in your Tools account instead. Requesting AWS MGN Initialization AWS MGN must be initialized by AMS before ﬁrst use. To request this for a new Tools account, submit a Management \| Other \| Other RFC from the Tools account with these details: RFC Subject=Please initialize AWS MGN in this account RFC Comment=Please click 'Get started' on the MGN welcome page here: https://console.aws.amazon.com/mgn/home?region=MALZ_PRIMARY_REGION#/welcome using all default values to 'Create template' and complete the initialization process. Once AMS successfully completes the RFC and initializes AWS MGN in your Tools account, you can use AWSManagedServicesMigrationRole to edit the default template for your requirements. Tools account (migrating workloads) Version September 13, 2024 48 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tools account (migrating workloads) Version September 13, 2024 49 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Enable access to the new AMS Tools account Once the tools account is created, AMS provides you with an account ID. Your next step is to conﬁgure access to the new account. Follow these steps. 1. Update the appropriate Active Directory groups to the appropriate account IDs. New AMS-created accounts are provisioned with the ReadOnly role policy as well as a role to allow users to ﬁle RFCs.
ams-appguide-019	ams-appguide.pdf	19	13, 2024 48 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tools account (migrating workloads) Version September 13, 2024 49 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Enable access to the new AMS Tools account Once the tools account is created, AMS provides you with an account ID. Your next step is to conﬁgure access to the new account. Follow these steps. 1. Update the appropriate Active Directory groups to the appropriate account IDs. New AMS-created accounts are provisioned with the ReadOnly role policy as well as a role to allow users to ﬁle RFCs. The Tools account also has an additional IAM role and user available: • IAM role: AWSManagedServicesMigrationRole • IAM user: customer_cloud_endure_user 2. Request policies and roles to allow service integration team members to set up the next level of tools. Navigate to the AMS console and ﬁle the following RFCs: a. Create KMS key. Use either Create KMS Key (auto) or Create KMS Key (review required). As you use KMS to encrypt ingested resources, using a single KMS key that is shared with the rest of the Multi-Account Landing Zone application accounts, provides security for ingested images where they can be decrypted in the destination account. b. Share the KMS key. Use the Management \| Other \| Other \| Create (ct-1e1xtak34nx76) change type to request that the new KMS key be shared with your application accounts where ingested AMIs will reside. Example graphic of a ﬁnal account setup: Tools account (migrating workloads) Version September 13, 2024 50 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Example AMS pre-approved IAM CloudEndure policy To see an AMS pre-approved IAM CloudEndure policy: Unpack the WIGS Cloud Endure Landing Zone Example ﬁle and open the customer_cloud_endure_policy.json. Testing AMS Tools account connectivity and end-to-end setup 1. Start with conﬁguring CloudEndure and installing the CloudEndure agent on a server that will replicate to AMS. 2. Create a project in CloudEndure. 3. Enter the AWS credentials shared when you performed the prerequisites, though secrets manager. Tools account (migrating workloads) Version September 13, 2024 51 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. In Replication settings: a. Select both AMS "Sentinel" security groups (Private Only and EgressAll) for the Choose the Security Groups to apply to the Replication Servers option. b. Deﬁne cutover options for the machines (instances). For information, see Step 5. Cut over c. Subnet: Private subnet. 5. Security Group: a. Select both AMS "Sentinel" security groups (Private Only and EgressAll). b. Cutover instances have to communicate to the AMS-managed Active Directory (MAD) and to AWS public endpoints: i. Elastic IP: None ii. Public IP: no iii. IAM role: customer-mc-ec2-instance-proﬁle c. Set tags as per your internal tagging convention. 6. Install the CloudEndure agent on the machine and look for the replication instance to come up in your AMS account in the EC2 console. The AMS ingestion process: Tools account (migrating workloads) Version September 13, 2024 52 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tools account (migrating workloads) Version September 13, 2024 53 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS Tools account hygiene You'll want to clean up after you are done in the account have shared the AMI and no longer have a need for the replicated instances: • Post instance WIGs ingestion: • Cutover instance: At a minimum, stop or terminate this instance, after the work has been completed, via the AWS console • Pre-Ingestion AMI backups: Remove once the instance has been ingested and the on-premise instance terminated • AMS-ingested instances: Turn oﬀ the stack or terminate once the AMI has been shared • AMS-ingested AMIs: Delete once sharing with the destination account is completed • End of migration clean up: Document the resources deployed through Developer mode to ensure clean-up happens on regular basis, for example: • Security groups • Resources created via Cloud-formation • Network ACK • Subnet • VPC • Route Table • Roles • Users and accounts Migration at scale - Migration Factory See Introducing AWS CloudEndure Migration Factory Solution. Migrating workloads: Linux pre-ingestion validation You can validate that your instance is ready for ingestion into your AMS account. The workload ingest (WIGS) pre-ingestion validation performs checks such as operating system type, available disk space, the existence of conﬂicting third party software, etc. When executed, the WIGS pre- ingestion validation produces an on-screen table, with an optional log ﬁle. The results provide a pass/fail status for each validation check along with the reason for any failures. In addition, you can customize the validation tests to suit your needs. Migrating workloads: Linux pre-ingestion validation Version September 13, 2024 54 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Frequently asked questions: • How do I use Linux WIGS
ams-appguide-020	ams-appguide.pdf	20	account. The workload ingest (WIGS) pre-ingestion validation performs checks such as operating system type, available disk space, the existence of conﬂicting third party software, etc. When executed, the WIGS pre- ingestion validation produces an on-screen table, with an optional log ﬁle. The results provide a pass/fail status for each validation check along with the reason for any failures. In addition, you can customize the validation tests to suit your needs. Migrating workloads: Linux pre-ingestion validation Version September 13, 2024 54 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Frequently asked questions: • How do I use Linux WIGS pre-ingestion validation? Follow these steps to download and use the AMS Linux WIGS pre-ingestion validation scripts: 1. Download a ZIP ﬁle with the validation scripts Linux WIGS Pre-ingestion Validation zip ﬁle. 2. Unzip attached rules to a directory of your choice. 3. Follow the instructions in the readme.md ﬁle. • What validations are performed by the Linux WIGS pre-ingestion validation? The AMS Linux WIGS pre-ingestion validation solution validates the following: 1. There are at least 5 Gigabytes free on the boot volume. 2. The operating system is supported by AMS. 3. The instance has a speciﬁc instance proﬁle. 4. The instance does not contain Antivirus software or Virtualization software. 5. SSH is properly conﬁgured. 6. The instance has access to Yum Repositories. 7. Enhanced networking drivers are installed. 8. The instance has the SSM Agent and it is running. • Why is there support for a custom conﬁguration ﬁle? The scripts are designed to run on both on-premise physical servers and on AWS EC2 instances. However, as shown in the list above, some tests will fail when run on-premises. For example, a physical server in a datacenter would not have an instance proﬁle. In cases like these, you can edit the conﬁguration ﬁle to skip the instance proﬁle test to avoid confusion. • How do I ensure I have the latest version of the script? An up-to-date version of the Linux WIGS Pre-Ingestion Validation solution will be available under AMS Helper Files section on the main Documentation page. • Is the script read-only? The script is designed to be read-only except for the log ﬁles it produces, but best practices should be followed to run the script in a non-production environment. • Is WIGS pre-ingestion validation available for Windows? Migrating workloads: Linux pre-ingestion validation Version September 13, 2024 55 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Yes. It is available under the AMS Helper Files section on the main Documentation page. Migrating workloads: Windows pre-ingestion validation You can use the pre-WIGs validator script to validate that your instance is ready for ingestion into your AMS account. The workload ingest (WIGS) pre-ingestion validation performs checks such as operating system type, available disk space, the existence of conﬂicting third party software, and so on. When run, the WIGS pre-ingestion validation produces an on-screen table and an optional log ﬁle. The results provide a pass/fail status for each validation check along with the failure reason. In addition, you can customize the validation tests. Frequently asked questions: • How do I use Windows WIGS pre-ingestion validation? You can run the validation from a GUI and web browser, or you can use Windows PowerShell, SSM Run Command, or SSM Session Manager. Option 1: Run from a GUI and web browser To run the Windows pre-WIGs validation from a GUI and web browser, do the following: 1. Download a ZIP ﬁle with the validation scripts: Windows WIGS Pre-ingestion Validation ZIP ﬁle. 2. Unzip attached rules to a directory of your choice. 3. Follow the instructions in the README.md ﬁle. Option 2: Run from Windows PowerShell, SSM Run Command, or SSM Session Manager Windows 2016 and later 1. Download the ZIP ﬁle with the validation scripts. $DestinationFile = "$env:TEMP\WIGValidation.zip" $Bucket = 'https://docs.aws.amazon.com/managedservices/latest/appguide/samples/ windows-prewigs-validation.zip' $DestinationFile = "$env:TEMP\WIGValidation.zip" $ScriptFolder = "$env:TEMP\AWSManagedServices.PreWigs.Validation" Migrating workloads: Windows pre-ingestion validation Version September 13, 2024 56 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Remove existing ﬁles from C:\Users\AppData\Local\Temp \AWSManagedServices.PreWigs.Validation. Remove-Item $scriptFolder -Recurse -Force -ErrorAction Ignore 3. Invoke the script. Invoke-WebRequest -Uri $bucket -OutFile $DestinationFile Add-Type -Assembly "system.io.compression.filesystem" 4. Unzip attached ﬁles to a directory of your choice. [io.compression.zipfile]::ExtractToDirectory($DestinationFile, $env:TEMP) 5. Run the validation script interactively and view the results. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation -RunWithoutExitCodes 6. (Optional) To capture the error codes listed in the Exit Codes section, run the script without the RunWithoutExitCodes option. Note that this command terminates the active PowerShell session. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation Windows 2012 R2 and earlier If you're running Windows Server 2012R2 or below, you must set TLS before you download the zip ﬁle. To set TLS, complete the following steps: 1. Download the ZIP ﬁle with the validation scripts. $DestinationFile = "$env:TEMP\WIGValidation.zip" $Bucket = 'https://docs.aws.amazon.com/managedservices/latest/appguide/samples/ windows-prewigs-validation.zip' $DestinationFile = "$env:TEMP\WIGValidation.zip" $ScriptFolder
ams-appguide-021	ams-appguide.pdf	21	[io.compression.zipfile]::ExtractToDirectory($DestinationFile, $env:TEMP) 5. Run the validation script interactively and view the results. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation -RunWithoutExitCodes 6. (Optional) To capture the error codes listed in the Exit Codes section, run the script without the RunWithoutExitCodes option. Note that this command terminates the active PowerShell session. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation Windows 2012 R2 and earlier If you're running Windows Server 2012R2 or below, you must set TLS before you download the zip ﬁle. To set TLS, complete the following steps: 1. Download the ZIP ﬁle with the validation scripts. $DestinationFile = "$env:TEMP\WIGValidation.zip" $Bucket = 'https://docs.aws.amazon.com/managedservices/latest/appguide/samples/ windows-prewigs-validation.zip' $DestinationFile = "$env:TEMP\WIGValidation.zip" $ScriptFolder = "$env:TEMP\AWSManagedServices.PreWigs.Validation" 2. If there are existing validation ﬁles, then remove them. Migrating workloads: Windows pre-ingestion validation Version September 13, 2024 57 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Remove-Item $scriptFolder -Recurse -Force -ErrorAction Ignore 3. Set the TLS version. [System.Net.ServicePointManager]::SecurityProtocol = 'TLS12' 4. Download WIG validation. Invoke-WebRequest -Uri $bucket -OutFile $DestinationFile Add-Type -Assembly "system.io.compression.filesystem" 5. Unzip the attached rules to a directory of your choice. [io.compression.zipfile]::ExtractToDirectory($DestinationFile, $env:TEMP) 6. Run the validation script interactively and view the results. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation -RunWithoutExitCodes 7. (Optional) To capture the error codes listed in the Exit Codes section, run the script without the RunWithoutExitCodes option. Note that this command terminates the active PowerShell session. Import-Module .\AWSManagedServices.PreWigs.Validation.psm1 -force Invoke-PreWIGsValidation Note You can download and run the PowerShell scripts. To do this, download the pre-wigs- validation-powershell-scripts.zip. • What validations are performed by the Windows WIGS Pre-Ingestion Validation? The AMS Windows WIGS pre-ingestion validation solution validates the following: 1. There is at least 10 Gigabytes free on the boot volume. 2. The operating system is supported by AMS. 3. The instance has a speciﬁc instance proﬁle. Migrating workloads: Windows pre-ingestion validation Version September 13, 2024 58 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. The instance does not contain antivirus software or virtualization software. 5. DHCP is enabled on at least one network adapter. 6. The instance is ready for Sysprep. • For 2008 R2 and 2012 Base and R2, Sysprep veriﬁes that: • There is an unattend.xml ﬁle • The sppnp.dll ﬁle(if present) is not corrupt • The Operating System has not been upgraded • Sysprep has not run more than the maximum number of times per Microsoft guidelines • For 2016 and above, all of above checks are skipped as neither cause problems for that OS 7. The Windows management instrumentation (WMI) subsystem is healthy. 8. Required drivers are installed. 9. The SSM Agent and is installed and running. 10.Warning is given to verify if the machine is in grace period due to the RDS License Conﬁguration. 11.Required registry keys are set properly. For more details, see the README in the Pre-ingestion Validation zip ﬁle. • Why is there support for a custom conﬁguration ﬁle? The scripts are designed to run on both on-premise physical servers and on AWS EC2 instances. However, as shown in the list above, some tests will fail when run on-premises. For example, a physical server in a datacenter would not have an instance proﬁle. In cases like these, you can edit the conﬁguration ﬁle to skip the instance proﬁle test to avoid confusion. • How do I ensure I have the latest version of the script? An up-to-date version of the Windows WIGS pre-ingestion validation solution will be available under the AMS Helper Files section on the main Documentation page. • Is the script read-only? The script is designed to be read-only except for the log ﬁles it produces, but best practices should be followed to run the script in a non-production environment. • Is WIGS Pre-Ingestion Validation available for Linux? Yes. The Linux version launched on 31 October, 2019. It is available under the AMS Helper Files section on the main Documentation page. Migrating workloads: Windows pre-ingestion validation Version September 13, 2024 59 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Workload Ingest Stack: Creating Migrating an instance to an AMS stack with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. Workload Ingest Stack: Creating Version September 13, 2024 60 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or
ams-appguide-022	ams-appguide.pdf	22	list page, and then click Create RFC. Workload Ingest Stack: Creating Version September 13, 2024 60 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Migrating an instance to an AMS stack with the CLI How it works: Workload Ingest Stack: Creating Version September 13, 2024 61 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. You can use the AMS CLI to create an AMS instance from a non-AMS instance migrated to an AMS account. Note Be sure you have followed the prerequisites; see Migrating Workloads: Prerequisites for Linux and Windows. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Workload Ingest Stack: Creating Version September 13, 2024 62 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-257p9zjk14ija" --change-type-version "2.0" -- title "AMS-WIG-TEST-NO-ACTION" --execution-parameters "{\"InstanceId\":\"INSTANCE_ID\", \"TargetVpcId\":\"VPC_ID\",\"TargetSubnetId\":\"SUBNET_ID\",\"TargetInstanceType\": \"t2.large\",\"ApplyInstanceValidation\":true,\"Name\":\"WIG-TEST\",\"Description\": \"WIG-TEST\",\"EnforceIMDSV2\":\"false\"}" TEMPLATE CREATE: 1. 0utput the execution parameters JSON schema for this change type to a ﬁle; example names it MigrateStackParams.json: aws amscm get-change-type-version --change-type-id "ct-257p9zjk14ija" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > MigrateStackParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "InstanceId": "MIGRATED_INSTANCE_ID", "TargetVpcId": "VPC_ID", "TargetSubnetId": "SUBNET_ID", "Name": "Migrated-Stack", "Description": "Create-Migrated-Stack", "EnforceIMDSV2": "false" } 3. Output the RFC template JSON ﬁle; example names it MigrateStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > MigrateStackRfc.json 4. Modify and save the MigrateStackRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-257p9zjk14ija", "ChangeTypeVersion": "2.0", "Title": "Migrate-Stack-RFC" Workload Ingest Stack: Creating Version September 13, 2024 63 AMS Advanced Application Developer's Guide AMS
ams-appguide-023	ams-appguide.pdf	23	get-change-type-version --change-type-id "ct-257p9zjk14ija" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > MigrateStackParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "InstanceId": "MIGRATED_INSTANCE_ID", "TargetVpcId": "VPC_ID", "TargetSubnetId": "SUBNET_ID", "Name": "Migrated-Stack", "Description": "Create-Migrated-Stack", "EnforceIMDSV2": "false" } 3. Output the RFC template JSON ﬁle; example names it MigrateStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > MigrateStackRfc.json 4. Modify and save the MigrateStackRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-257p9zjk14ija", "ChangeTypeVersion": "2.0", "Title": "Migrate-Stack-RFC" Workload Ingest Stack: Creating Version September 13, 2024 63 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options } 5. Create the RFC, specifying the MigrateStackRfc ﬁle and the MigrateStackParams ﬁle: aws amscm create-rfc --cli-input-json file://MigrateStackRfc.json --execution- parameters file://MigrateStackParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. The new instance appears in the Instance list for the application owner's account for the relevant VPC. 6. Once the RFC completes successfully, notify the application owner so he or she can log into the new instance and verify that the workload is operational. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Tips Note Be sure you have followed the prerequisites; see Migrating Workloads: Prerequisites for Linux and Windows. Note If a tag on the instance being migrated has the same key as a tag supplied in the RFC, the RFC fails. Workload Ingest Stack: Creating Version September 13, 2024 64 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note You can specify up to four Target IDs, Ports, and Availability Zones. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. If needed, see Workload ingestion (WIGS) failure. AMS CloudFormation ingest The AMS AWS CloudFormation ingest change type (CT) enables you to use your existing CloudFormation templates, with some modiﬁcations, to deploy custom stacks in an AMS-managed VPC. Topics • AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS CloudFormation Ingest: Examples • Create CloudFormation ingest stack • Update AWS CloudFormation ingest stack • Approve a CloudFormation ingest stack changeset AMS CloudFormation ingest Version September 13, 2024 65 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Update AWS CloudFormation stacks termination protection • Automated IAM deployments using CFN ingest or stack update CTs in AMS The AMS AWS CloudFormation ingest process involves the following: • Prepare and upload your custom CloudFormation template to an S3 bucket, or provide the template inline when creating the RFC. If you are using an S3 bucket with a presigned URL; for more information, see presign. • Submit the CloudFormation ingest change type to AMS in an RFC. For the CFN ingest change type walkthrough, see Create CloudFormation ingest stack. For CFN ingest examples, see AWS CloudFormation Ingest: Examples. • Once your stack is created, you can update it, and remediate drift on it; additionally, should the update fail, you can explicitly approve and implement the update. All of these procedures are described in this section. For information on CFN drift detection, see New – CloudFormation Drift Detection. Note • This change type now has a version 2.0. Version 2.0 is automated; not manually executed. This enables the CT execution to go more quickly. Two new parameters are introduced with this version: CloudFormationTemplate, which enables you to paste a custom CloudFormation template into the RFC, and VpcId, which enables CloudFormation ingest to be used with AMS multi-account landing zone. • Version 1.0 is a manual change type. This means that an AMS operator must take some action before the change type can successfully conclude. At minimum, a review is required. This version also requires the CloudFormationTemplateS3Endpoint parameter value to be a pre-signed URL. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations For AMS to process your CloudFormation template, there are
ams-appguide-024	ams-appguide.pdf	24	to go more quickly. Two new parameters are introduced with this version: CloudFormationTemplate, which enables you to paste a custom CloudFormation template into the RFC, and VpcId, which enables CloudFormation ingest to be used with AMS multi-account landing zone. • Version 1.0 is a manual change type. This means that an AMS operator must take some action before the change type can successfully conclude. At minimum, a review is required. This version also requires the CloudFormationTemplateS3Endpoint parameter value to be a pre-signed URL. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations For AMS to process your CloudFormation template, there are some guidelines and restrictions. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 66 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Guidelines To reduce AWS CloudFormation errors while performing AWS CloudFormation ingest, follow these guidelines: • Don't embed credentials or other sensitive information in the template – The CloudFormation template is visible in the AWS CloudFormation console, so you don't want to embed credentials or sensitive data in the template. The template can't contain sensitive information. The following resources are allowed only if you use AWS Secrets Manager for the value: • AWS::RDS::DBInstance - [MasterUserPassword,TdeCredentialPassword] • AWS::RDS::DBCluster - [MasterUserPassword] • AWS::ElastiCache::ReplicationGroup - [AuthToken] Note For information about using an AWS Secrets Manager secret in a resource property, see How to create and retrieve secrets managed in AWS Secrets Manager using AWS CloudFormation templates and Using Dynamic References to Specify Template Values. • Use Amazon RDS snapshots to create RDS DB instances – By doing this you avoid having to provide a MasterUserPassword. • If the template you submit contains an IAM instance proﬁle, it must be preﬁxed with 'customer'. For example, using an instance proﬁle with the name 'example-instance-proﬁle', causes failure. Instead, use an instance proﬁle with the name 'customer-example-instance-proﬁle'. • Don't include any sensitive data in AWS::EC2::Instance - [UserData]. UserData should not contain passwords, API keys, or any other sensitive data. This type of data can be encrypted and stored in an S3 bucket and downloaded onto the instance using UserData. • IAM policy creation using CloudFormation templates is supported with constraints – IAM policies have to be reviewed and approved by AMS SecOps. Currently we only support deploying IAM roles with in-line policies that contain pre-approved permissions. In other cases, IAM policies can't be created using CloudFormation templates because that would override the AMS SecOps process. • SSH KeyPairs aren't supported – Amazon EC2 instances must be accessed through the AMS access management system. The AMS RFC process authenticates you. You cannot include SSH keypairs in CloudFormation templates because you don't have the permissions to create SSH keypairs and override the AMS access management model. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 67 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Security Group ingress rules are restricted – You can't have a source CIDR range from 0.0.0.0/0, or a publicly routable address space, with a TCP port that is anything other than 80 or 443. • Follow AWS CloudFormation guidelines when writing CloudFormation resource templates – Ensure that you use the right data type/property name for the resource by referring to the AWS CloudFormation User Guide for that resource. For example, the data type of SecurityGroupIds property in an AWS::EC2::Instance resource is 'List of String values', so ["sg-aaaaaaaa"] is ok (with brackets), but "sg-aaaaaaaa" is not (without brackets). For more information, see AWS Resource and Property Types Reference. • Conﬁgure your custom CloudFormation templates to use parameters deﬁned in the AMS CloudFormation ingest CT – When you conﬁgure your CloudFormation template to use parameters deﬁned in the AMS CloudFormation ingest CT, you can reuse the CloudFormation template to create similar stacks by submitting it with changed parameter values in the CT input with the Management \| Custom stack \| Stack from CloudFormation template \| Update CT (ct-361tlo1k7339x). For an example, see AWS CloudFormation Ingest examples: Deﬁning resources. • Amazon S3 bucket endpoints with a presigned URL can't be expired – If you are using an Amazon S3 bucket endpoint with a presigned URL, verify that the presigned Amazon S3 URL isn't expired. A CloudFormation ingest RFC submitted with an expired presigned Amazon S3 bucket URL is rejected. • Wait Condition requires signal logic – Wait Condition is used to coordinate stack resource creation with conﬁguration actions that are external to the stack creation. If you use the Wait Condition resource in the template, AWS CloudFormation waits for a success signal, and it marks stack creation as a failure if the number of success signals aren't made. You need to have a logic for the signal if you use the Wait Condition resource. For more information, see Creating Wait Conditions in a Template. Best Practices
ams-appguide-025	ams-appguide.pdf	25	ingest RFC submitted with an expired presigned Amazon S3 bucket URL is rejected. • Wait Condition requires signal logic – Wait Condition is used to coordinate stack resource creation with conﬁguration actions that are external to the stack creation. If you use the Wait Condition resource in the template, AWS CloudFormation waits for a success signal, and it marks stack creation as a failure if the number of success signals aren't made. You need to have a logic for the signal if you use the Wait Condition resource. For more information, see Creating Wait Conditions in a Template. Best Practices Following are some best practices you can use to migrate resources using the AMS AWS CloudFormation ingest process: • Submit IAM and other policy-related resources in one CT– If you can use automated CTs such as CloudFormation Ingest to deploy IAM roles, we recommend you do so. In other cases, AMS recommends that you gather all IAM or other policy-related resources and submit them in a single Management \| Other \| Other \| Create change type (ct-1e1xtak34nx76). For example, AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 68 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options combine needed all IAM roles, IAM Amazon EC2 instance proﬁles, IAM policy updates for existing IAM roles, Amazon S3 bucket policies, Amazon SNS/Amazon SQS policies, and so forth, and submit a ct-1e1xtak34nx76 RFC so that these pre-existing resources can simply be referenced inside the future CloudFormation ingest templates. • EC2 instances are bootstrapped and successfully joined to the domain – This is done automatically as a best practice. To ensure that the Amazon EC2 instances launched via a CloudFormation ingest stack are bootstrapped and join the domain successfully, AMS includes a CreationPolicy and an UpdatePolicy for an Auto Scaling group resource (that is, if these policies don't already exist). • Amazon RDS DB instance parameter must be speciﬁed– When creating an Amazon RDS database via AWS CloudFormation ingest, you must specify the DBSnapshotIdentifier parameter in order to restore from a previous DB snapshot. This is required because AWS CloudFormation ingest does not currently handle sensitive data. For an example of how to use a CloudFormation template for AMS CloudFormation template ingest, see AWS CloudFormation Ingest: Examples. Template validation You can self-validate your CloudFormation template before submitting it to AMS. Templates submitted to AMS AWS CloudFormation ingest are validated to ensure they are safe to deploy within an AMS account. The validation process checks the following: • Supported resources – Only AMS AWS CloudFormation ingest-supported resources are used. For more information, see Supported Resources. • Supported AMIs – The AMI in the template is an AMS-supported AMI. For information about AMS AMIs, see AMS Amazon Machine Images (AMIs). • AMS Shared Services subnet – The template does not attempt to launch resources into the AMS Shared Services subnet. • Resource policies – There are no overly permissive resource policies, such as a publicly readable or writeable S3 bucket policy. AMS doesn't allow publicly readable or writable S3 buckets in AWS accounts. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 69 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Validate with AWS CloudFormation Linter You can self-validate your CloudFormation template before submitting it to AMS by using the AWS CloudFormation Linter tool. The AWS CloudFormation Linter tool is the best way to validate your CloudFormation template as it provides validation for resource/property names, data types, and functions. For more information, see aws-cloudformation/cfn-python-lint. The AWS CloudFormation Linter output of the template shown previously is as follows: $ cfn-lint -t ./testtmpl.json E3002 Invalid Property Resources/SNSTopic/Properties/Name ./testtmpl.json:6:9 To assist with oﬄine validation of CloudFormation templates, AMS has developed a set of pluggable custom validation rules for the AWS CloudFormation Linter tool. They're located on the Developers Resources page of the AMS console. Follow these steps to use AWS CloudFormation pre-ingestion validation scripts: 1. Install the AWS CloudFormation Linter tool. For installation instructions, see aws- cloudformation / cfn-lint . 2. Download a .zip ﬁle with validation scripts: CFN Lint Custom Rules. 3. Unzip the attached rules to a directory of your choice. 4. Validate your CloudFormation template by running the following command: cfn-lint --template {TEMPLATE_FILE} --append-rules {DIRECTORY_WITH_CUSTOM_RULES} CloudFormation ingest stack: CFN validator examples These examples can help you prepare your template for a successful ingest. Format validation Validate that the template contains a "Resources" section, and all resources deﬁned under it have a "Type" value. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 70 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "AWSTemplateFormatVersion": "2010-09-09", "Description" : "Create a SNS topic", "Resources": { "SnsTopic": { "Type": "AWS::SNS::Topic" } } } Validate that the root keys of the template are allowed. Allowed root
ams-appguide-026	ams-appguide.pdf	26	running the following command: cfn-lint --template {TEMPLATE_FILE} --append-rules {DIRECTORY_WITH_CUSTOM_RULES} CloudFormation ingest stack: CFN validator examples These examples can help you prepare your template for a successful ingest. Format validation Validate that the template contains a "Resources" section, and all resources deﬁned under it have a "Type" value. AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 70 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "AWSTemplateFormatVersion": "2010-09-09", "Description" : "Create a SNS topic", "Resources": { "SnsTopic": { "Type": "AWS::SNS::Topic" } } } Validate that the root keys of the template are allowed. Allowed root keys are: [ "AWSTemplateFormatVersion", "Description", "Mappings", "Parameters", "Conditions", "Resources", "Rules", "Outputs", "Metadata" ] Manual review required validation If the template contains the following resources, automatic validation fails and you'll need a manual review. The shown policies are high risk areas from a security standpoint. For example, an S3 bucket policy allowing anyone except for speciﬁc users or groups to create objects or write permissions, is extremely dangerous. So we validate the policies and approve or deny based on the contents, and those polices cannot be auto-created. We are investigating possible approaches to address this issue. We currently don’t have automated validation around the following resources. [ "S3::BucketPolicy", "SNS::TopicPolicy", "SQS::QueuePolicy" AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 71 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options ] Parameter validation Validate that if a template parameter doesn't have a value provided; it must have a default value. Resource attribute validation Required attribute check: Certain attributes must exist for certain resource types. • "VPCOptions" must exist in AWS::OpenSearch::Domain • "CludsterSubnetGroupName" must exist in AWS::Redshift::Cluster { "AWS::OpenSearch::Domain": [ "VPCOptions" ], "AWS::Redshift::Cluster": [ "ClusterSubnetGroupName" ] } Disallowed attributes check: Certain attributes must not exist for certain resource types. • "SecretString" must not exist in "AWS::SecretsManager::Secret" • "MongoDbSettings" must not exist in "AWS::DMS::Endpoint" { "AWS::SecretsManager::Secret": [ "SecretString" ], "AWS::DMS::Endpoint": [ "MongoDbSettings" ] } SSM parameter check: For attributes in the following list, values must be speciﬁed via Secrets Manager or Systems Manager Parameter Store (Secure String Parameter): { AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 72 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "RDS::DBInstance": [ "MasterUserPassword", "TdeCredentialPassword" ], "RDS::DBCluster": [ "MasterUserPassword" ], "ElastiCache::ReplicationGroup": [ "AuthToken" ], "DMS::Certificate": [ "CertificatePem", "CertificateWallet" ], "DMS::Endpoint": [ "Password" ], "CodePipeline::Webhook": { "AuthenticationConfiguration": [ "SecretToken" ] }, "DocDB::DBCluster": [ "MasterUserPassword" ] }, Some attributes must comply with certain patterns; for example, IAM instance proﬁle names must not start with AMS reserved preﬁxes, and the attribute value must match the speciﬁc regex as shown: { "AWS::EC2::Instance": { "IamInstanceProfile": [ "^(?!arn:aws:iam\|ams\|Ams\|AMS\|AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\| sentinel\|Sentinel).+", "arn:aws:iam::(\\$\\{AWS::AccountId\\}\|[0-9]+):instance-profile/(?!ams\|Ams\|AMS\| AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\|sentinel\|Sentinel).+" ] }, "AWS::AutoScaling::LaunchConfiguration": { "IamInstanceProfile": [ AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 73 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "^(?!arn:aws:iam\|ams\|Ams\|AMS\|AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\| sentinel\|Sentinel).+", "arn:aws:iam::(\\$\\{AWS::AccountId\\}\|[0-9]+):instance-profile/(?!ams\|Ams\|AMS\| AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\|sentinel\|Sentinel).+" ] }, "AWS::EC2::LaunchTemplate": { "LaunchTemplateData.IamInstanceProfile.Name": [ "^(?!ams\|Ams\|AMS\|AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\|sentinel\| Sentinel).+" ], "LaunchTemplateData.IamInstanceProfile.Arn": [ "arn:aws:iam::(\\$\\{AWS::AccountId\\}\|[0-9]+):instance-profile\/(?!ams\|Ams\| AMS\|AWSManagedServices\|Managed_Services\|mc\|Mc\|MC\|sentinel\|Sentinel).+" ] } } Resource validation Only allowlisted resources can be speciﬁed in the template; those resources are described in Supported Resources. EC2 stacks and Auto Scaling groups (ASGs) are not allowed in the same stack due to patching limitations. Security group ingress rule validation • For requests that come from the CFN Ingest Create or Stack Update CT change types: • If (IpProtocol is tcp or 6) AND (Port is 80 or 443) , there are no restrictions around the CidrIP value • Otherwise, the CidrIP cannot be 0.0.0.0/0 • For requests that come from Service Catalog (Service Catalog products): • In addition to the CFN Ingest Create or Stack Update CT change type validation, the port in management_ports with the protocol in ip_protocols can only be accessed via allowed_cidrs: { "ip_protocols": ["tcp", "6", "udp", "17"], "management_ports": [22, 23, 389, 636, 1494, 1604, 2222, 3389, 5900, 5901, 5985, 5986], AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 74 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "allowed_cidrs": ["10.0.0.0/8", "100.64.0.0/10", "172.16.0.0/12", "192.168.0.0/16"] } Limitations The following features and functionality currently aren't supported by the AMS AWS CloudFormation ingest process. • YAML – Not supported. Only JSON-based CloudFormation templates are supported. • Nested stacks – Instead, architect your application infrastructure to use a single template. Or, alternatively you can make use of cross-stack referencing to separate resources across multiple stacks where one resource has a dependency on another. For more information, see Walkthrough: Refer to Resource Outputs in Another AWS CloudFormation Stack. • CloudFormation stack sets – Not supported, due to security implications. • IAM resource creation using CloudFormation templates – Only IAM roles are supported, due to security implications. • Sensitive data – Not supported. Do not include sensitive data in the template or in the parameter values. If you need to reference
ams-appguide-027	ams-appguide.pdf	27	– Instead, architect your application infrastructure to use a single template. Or, alternatively you can make use of cross-stack referencing to separate resources across multiple stacks where one resource has a dependency on another. For more information, see Walkthrough: Refer to Resource Outputs in Another AWS CloudFormation Stack. • CloudFormation stack sets – Not supported, due to security implications. • IAM resource creation using CloudFormation templates – Only IAM roles are supported, due to security implications. • Sensitive data – Not supported. Do not include sensitive data in the template or in the parameter values. If you need to reference sensitive data, use Secrets Manager to store and retrieve these values. For information about using AWS Secrets Managers secrets in a resource property, see How to create and retrieve secrets managed in AWS Secrets Manager using AWS CloudFormation templates and Using Dynamic References to Specify Template Values. Supported Resources The following AWS resources are supported in the AMS AWS CloudFormation ingest process. CloudFormation Ingest Stack: Supported resources The instance operating system must be supported by AMS workload ingestion. Only those AWS resources listed here are supported. • Amazon API Gateway • AWS::ApiGateway::Account • AWS::ApiGateway::ApiKey • AWS::ApiGateway::Authorizer AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 75 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::ApiGateway::BasePathMapping • AWS::ApiGateway::ClientCertiﬁcate • AWS::ApiGateway::Deployment • AWS::ApiGateway::DocumentationPart • AWS::ApiGateway::DocumentationVersion • AWS::ApiGateway::DomainName • AWS::ApiGateway::GatewayResponse • AWS::ApiGateway::Method • AWS::ApiGateway::Model • AWS::ApiGateway::RequestValidator • AWS::ApiGateway::Resource • AWS::ApiGateway::RestApi • AWS::ApiGateway::Stage • AWS::ApiGateway::UsagePlan • AWS::ApiGateway::UsagePlanKey • AWS::ApiGateway::VpcLink • Amazon API Gateway V2 • AWS::ApiGatewayV2::Api • AWS::ApiGatewayV2::ApiGatewayManagedOverrides • AWS::ApiGatewayV2::ApiMapping • AWS::ApiGatewayV2::Authorizer • AWS::ApiGatewayV2::Deployment • AWS::ApiGatewayV2::DomainName • AWS::ApiGatewayV2::Integration • AWS::ApiGatewayV2::IntegrationResponse • AWS::ApiGatewayV2::Model • AWS::ApiGatewayV2::Route • AWS::ApiGatewayV2::RouteResponse • AWS::ApiGatewayV2::Stage AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::ApiGatewayV2::VpcLink Version September 13, 2024 76 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS AppSync • AWS::AppSync::ApiCache • AWS::AppSync::ApiKey • AWS::AppSync::DataSource • AWS::AppSync::FunctionConﬁguration • AWS::AppSync::GraphQLApi • AWS::AppSync::GraphQLSchema • AWS::AppSync::Resolver • Amazon Athena • AWS::Athena::NamedQuery • AWS::Athena::WorkGroup • AWS Backup • AWS::Backup::BackupVault • Amazon CloudFront • AWS::CloudFront::Distribution • AWS::CloudFront::CloudFrontOriginAccessIdentity • AWS::CloudFront::StreamingDistribution • Amazon CloudWatch • AWS::CloudWatch::Alarm • AWS::CloudWatch::AnomalyDetector • AWS::CloudWatch::CompositeAlarm • AWS::CloudWatch::Dashboard • AWS::CloudWatch::InsightRule • Amazon CloudWatch Logs • AWS::Logs::LogGroup • AWS::Logs::LogStream • AWS::Logs::MetricFilter • AWS::Logs::SubscriptionFilter • Amazon Cognito AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::Cognito::IdentityPool Version September 13, 2024 77 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::Cognito::IdentityPoolRoleAttachment • AWS::Cognito::UserPool • AWS::Cognito::UserPoolClient • AWS::Cognito::UserPoolDomain • AWS::Cognito::UserPoolGroup • AWS::Cognito::UserPoolIdentityProvider • AWS::Cognito::UserPoolResourceServer • AWS::Cognito::UserPoolRiskConﬁgurationAttachment • AWS::Cognito::UserPoolUICustomizationAttachment • AWS::Cognito::UserPoolUser • AWS::Cognito::UserPoolUserToGroupAttachment • Amazon DocumentDB • AWS::DocDB::DBCluster • AWS::DocDB::DBClusterParameterGroup • AWS::DocDB::DBInstance • AWS::DocDB::DBSubnetGroup • Amazon DynamoDB • AWS::DynamoDB::Table • Amazon EC2 • AWS::EC2::Volume • AWS::EC2::VolumeAttachment • AWS::EC2::Instance • AWS::EC2::EIP • AWS::EC2::EIPAssociation • AWS::EC2::NetworkInterface • AWS::EC2::NetworkInterfaceAttachment • AWS::EC2::SecurityGroup • AWS::EC2::SecurityGroupIngress • AWS::EC2::SecurityGroupEgress AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::EC2::LaunchTemplate Version September 13, 2024 78 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS Batch • AWS::Batch::ComputeEnvironment • AWS::Batch::JobDeﬁnition • AWS::Batch::JobQueue • Amazon Elastic Container Registry (ECR) • AWS::ECR::Repository • Amazon Elastic Container Service (ECS) (Fargate) • AWS::ECS::CapacityProvider • AWS::ECS::Cluster • AWS::ECS::PrimaryTaskSet • AWS::ECS::Service • AWS::ECS::TaskDeﬁnition • AWS::ECS::TaskSet • Amazon Elastic File System (EFS) • AWS::EFS::FileSystem • AWS::EFS::MountTarget • Amazon ElastiCache • AWS::ElastiCache::CacheCluster • AWS::ElastiCache::ParameterGroup • AWS::ElastiCache::ReplicationGroup • AWS::ElastiCache::SecurityGroup • AWS::ElastiCache::SecurityGroupIngress • AWS::ElastiCache::SubnetGroup • Amazon EventBridge • AWS::Events::EventBus • AWS::Events::EventBusPolicy • AWS::Events::Rule • Amazon FSx • AWS::FSx::FileSystem AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • Amazon Inspector Version September 13, 2024 79 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::Inspector::AssessmentTarget • AWS::Inspector::AssessmentTemplate • AWS::Inspector::ResourceGroup • Amazon Kinesis Data Analytics • AWS::KinesisAnalytics::Application • AWS::KinesisAnalytics::ApplicationOutput • AWS::KinesisAnalytics::ApplicationReferenceDataSource • Amazon Kinesis Data Firehose • AWS::KinesisFirehose::DeliveryStream • Amazon Kinesis Data Streams • AWS::Kinesis::Stream • AWS::Kinesis::StreamConsumer • Amazon MQ • AWS::AmazonMQ::Broker • AWS::AmazonMQ::Conﬁguration • AWS::AmazonMQ::ConﬁgurationAssociation • Amazon OpenSearch • AWS::OpenSearchService::Domain • Amazon Relational Database Service (RDS) • AWS::RDS::DBCluster • AWS::RDS::DBClusterParameterGroup • AWS::RDS::DBInstance • AWS::RDS::DBParameterGroup • AWS::RDS::DBSubnetGroup • AWS::RDS::EventSubscription • AWS::RDS::OptionGroup • Amazon Route 53 • AWS::Route53::HealthCheck • AWS::Route53::HostedZone AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::Route53::RecordSet Version September 13, 2024 80 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::Route53::RecordSetGroup • AWS::Route53Resolver::ResolverRule • AWS::Route53Resolver::ResolverRuleAssociation • Amazon S3 • AWS::S3::Bucket • Amazon Sagemaker • AWS::SageMaker::CodeRepository • AWS::SageMaker::Endpoint • AWS::SageMaker::EndpointConﬁg • AWS::SageMaker::Model • AWS::SageMaker::NotebookInstance • AWS::SageMaker::NotebookInstanceLifecycleConﬁg • AWS::SageMaker::Workteam • Amazon Simple Email Service (SES) • AWS::SES::ConﬁgurationSet • AWS::SES::ConﬁgurationSetEventDestination • AWS::SES::ReceiptFilter • AWS::SES::ReceiptRule • AWS::SES::ReceiptRuleSet • AWS::SES::Template • Amazon SimpleDB • AWS::SDB::Domain • Amazon SNS • AWS::SNS::Subscription • AWS::SNS::Topic • Amazon SQS • AWS::SQS::Queue • Amazon WorkSpaces • AWS::WorkSpaces::Workspace AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • Application AutoScaling Version September 13, 2024 81 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::ApplicationAutoScaling::ScalableTarget • AWS::ApplicationAutoScaling::ScalingPolicy • Amazon EC2 AutoScaling • AWS::AutoScaling::AutoScalingGroup • AWS::AutoScaling::LaunchConﬁguration • AWS::AutoScaling::LifecycleHook • AWS::AutoScaling::ScalingPolicy • AWS::AutoScaling::ScheduledAction • AWS Certiﬁcate Manager •
ams-appguide-028	ams-appguide.pdf	28	AWS::SageMaker::Endpoint • AWS::SageMaker::EndpointConﬁg • AWS::SageMaker::Model • AWS::SageMaker::NotebookInstance • AWS::SageMaker::NotebookInstanceLifecycleConﬁg • AWS::SageMaker::Workteam • Amazon Simple Email Service (SES) • AWS::SES::ConﬁgurationSet • AWS::SES::ConﬁgurationSetEventDestination • AWS::SES::ReceiptFilter • AWS::SES::ReceiptRule • AWS::SES::ReceiptRuleSet • AWS::SES::Template • Amazon SimpleDB • AWS::SDB::Domain • Amazon SNS • AWS::SNS::Subscription • AWS::SNS::Topic • Amazon SQS • AWS::SQS::Queue • Amazon WorkSpaces • AWS::WorkSpaces::Workspace AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • Application AutoScaling Version September 13, 2024 81 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::ApplicationAutoScaling::ScalableTarget • AWS::ApplicationAutoScaling::ScalingPolicy • Amazon EC2 AutoScaling • AWS::AutoScaling::AutoScalingGroup • AWS::AutoScaling::LaunchConﬁguration • AWS::AutoScaling::LifecycleHook • AWS::AutoScaling::ScalingPolicy • AWS::AutoScaling::ScheduledAction • AWS Certiﬁcate Manager • AWS::CertiﬁcateManager::Certiﬁcate • AWS CloudFormation • AWS::CloudFormation::CustomResource • AWS::CloudFormation::Designer • AWS::CloudFormation::WaitCondition • AWS::CloudFormation::WaitConditionHandle • AWS CodeBuild • AWS::CodeBuild::Project • AWS::CodeBuild::ReportGroup • AWS::CodeBuild::SourceCredential • AWS CodeCommit • AWS::CodeCommit::Repository • AWS CodeDeploy • AWS::CodeDeploy::Application • AWS::CodeDeploy::DeploymentConﬁg • AWS::CodeDeploy::DeploymentGroup • AWS CodePipeline • AWS::CodePipeline::CustomActionType • AWS::CodePipeline::Pipeline • AWS::CodePipeline::Webhook AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS Database Migration Service (DMS) Version September 13, 2024 82 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::DMS::Certiﬁcate • AWS::DMS::Endpoint • AWS::DMS::EventSubscription • AWS::DMS::ReplicationInstance • AWS::DMS::ReplicationSubnetGroup • AWS::DMS::ReplicationTask The MongoDbSettings property in AWS::DMS::Endpoint resource is not allowed. The following properties are only allowed if they are resolved by AWS Secrets Manager: CertiﬁcatePem and CertiﬁcateWallet properties in the AWS::DMS::Certiﬁcate resource, and the Password property in the AWS::DMS::Endpoint resource. • AWS Elastic Load Balancing - Application Load Balancer / Network Load Balancer • AWS::ElasticLoadBalancingV2::Listener • AWS::ElasticLoadBalancingV2::ListenerCertiﬁcate • AWS::ElasticLoadBalancingV2::ListenerRule • AWS::ElasticLoadBalancingV2::LoadBalancer • AWS::ElasticLoadBalancingV2::TargetGroup • AWS Elastic Load Balancing - Classic Load Balancer • AWS::ElasticLoadBalancing::LoadBalancer • AWS Elemental MediaConvert • AWS::MediaConvert::JobTemplate • AWS::MediaConvert::Preset • AWS::MediaConvert::Queue • AWS Elemental MediaStore • AWS::MediaStore::Container • AWS Identity and Access Management (IAM) • AWS::IAM::Role • AWS Managed Streaming for Apache Kafka (MSK) • AWS::MSK::Cluster • AWS Glue • AWS::Glue::Classiﬁer AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations Version September 13, 2024 83 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::Glue::Connection • AWS::Glue::Crawler • AWS::Glue::Database • AWS::Glue::DataCatalogEncryptionSettings • AWS::Glue::DevEndpoint • AWS::Glue::Job • AWS::Glue::MLTransform • AWS::Glue::Partition • AWS::Glue::SecurityConﬁguration • AWS::Glue::Table • AWS::Glue::Trigger • AWS::Glue::Workﬂow • AWS Key Management Service (KMS) • AWS::KMS::Key • AWS::KMS::Alias • AWS Lake Formation • AWS::LakeFormation::DataLakeSettings • AWS::LakeFormation::Permissions • AWS::LakeFormation::Resource • AWS Lambda • AWS::Lambda::Alias • AWS::Lambda::EventInvokeConﬁg • AWS::Lambda::EventSourceMapping • AWS::Lambda::Function • AWS::Lambda::LayerVersion • AWS::Lambda::LayerVersionPermission • AWS::Lambda::Permission • AWS::Lambda::Version • Amazon Redshift AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::Redshift::Cluster Version September 13, 2024 84 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::Redshift::ClusterParameterGroup • AWS::Redshift::ClusterSubnetGroup • AWS Secrets Manager • AWS::SecretsManager::ResourcePolicy • AWS::SecretsManager::RotationSchedule • AWS::SecretsManager::Secret • AWS::SecretsManager::SecretTargetAttachment • AWS Security Hub • AWS::SecurityHub::Hub • AWS Step Functions • AWS::StepFunctions::Activity • AWS::StepFunctions::StateMachine • AWS Systems Manager (SSM) • AWS::SSM::Parameter • Amazon CloudWatch Synthetics • AWS::Synthetics::Canary • AWS Transfer Family • AWS::Transfer::Server • AWS::Transfer::User • AWS WAF • AWS::WAF::ByteMatchSet • AWS::WAF::IPSet • AWS::WAF::Rule • AWS::WAF::SizeConstraintSet • AWS::WAF::SqlInjectionMatchSet • AWS::WAF::WebACL • AWS::WAF::XssMatchSet • AWS WAF Regional • AWS::WAFRegional::ByteMatchSet AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations • AWS::WAFRegional::GeoMatchSet Version September 13, 2024 85 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AWS::WAFRegional::IPSet • AWS::WAFRegional::RateBasedRule • AWS::WAFRegional::RegexPatternSet • AWS::WAFRegional::Rule • AWS::WAFRegional::SizeConstraintSet • AWS::WAFRegional::SqlInjectionMatchSet • AWS::WAFRegional::WebACL • AWS::WAFRegional::WebACLAssociation • AWS::WAFRegional::XssMatchSet • AWS WAFv2 • AWS::WAFv2::IPSet • AWS::WAFv2::RegexPatternSet • AWS::WAFv2::RuleGroup • AWS::WAFv2::WebACL • AWS::WAFv2::WebACLAssociation AWS CloudFormation Ingest: Examples Find here some detailed examples of how to use the Create stack with CloudFormation template change type. To download a set of sample CloudFormation templates per AWS Region, see Sample Templates. For reference information on AWS CloudFormation resources, see AWS Resource and Property Types Reference. However, AMS supports a smaller set of resources, which are described in AMS CloudFormation ingest. Note AMS advises you to gather all IAM or other policy-related resources and submit them in a single Management \| Other \| Other \| Create change type (ct-1e1xtak34nx76). For example, combine all needed IAM roles, IAM instance proﬁles, IAM policy updates for existing IAM roles, S3 bucket policies, SNS/SQS policies, and so forth, and then submit a AWS CloudFormation Ingest: Examples Version September 13, 2024 86 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options ct-1e1xtak34nx76 RFC so that these pre-existing resources can be referenced inside the future CFN Ingest templates. Topics • AWS CloudFormation Ingest examples: Deﬁning resources • CloudFormation Ingest examples: 3-tier Web application AWS CloudFormation Ingest examples: Deﬁning resources When using AMS AWS CloudFormation ingest, you customize a CloudFormation template and submit it to AMS in an RFC with the CloudFormation ingest change type (ct-36cn2avfrrj9v). To create a CloudFormation template that can be reused multiple times, you add the stack conﬁguration parameters to the CloudFormation ingest change type execution input rather than hard coding them in the CloudFormation template. The biggest beneﬁt is that you can reuse the template. The AMS CloudFormation ingest change type input schema enables you to
ams-appguide-029	ams-appguide.pdf	29	AWS CloudFormation Ingest examples: Deﬁning resources • CloudFormation Ingest examples: 3-tier Web application AWS CloudFormation Ingest examples: Deﬁning resources When using AMS AWS CloudFormation ingest, you customize a CloudFormation template and submit it to AMS in an RFC with the CloudFormation ingest change type (ct-36cn2avfrrj9v). To create a CloudFormation template that can be reused multiple times, you add the stack conﬁguration parameters to the CloudFormation ingest change type execution input rather than hard coding them in the CloudFormation template. The biggest beneﬁt is that you can reuse the template. The AMS CloudFormation ingest change type input schema enables you to choose up to sixty parameters in a CloudFormation template and provide custom values. This example shows how to deﬁne a resource property, which can be used in a variety of CloudFormation templates, as a parameter in the AMS CloudFormation ingest CT. The examples in this section speciﬁcally show SNS topic usage. Topics • Example 1: Hard code the AWS CloudFormation SNSTopic resource TopicName property • Example 2: Use an SNSTopic resource to reference a parameter in the AMS change type • Example 3: Create an SNS topic by submitting a JSON execution parameters ﬁle with the AMS ingest change type • Example 4: Submit a new change type that references the same CloudFormation template • Example 5: Use the default parameter values in the CloudFormation template Example 1: Hard code the AWS CloudFormation SNSTopic resource TopicName property In this example, you hard code the AWS CloudFormation SNSTopic resource TopicName property in the CloudFormation template. Note that the Parameters section is empty. AWS CloudFormation Ingest: Examples Version September 13, 2024 87 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options To have a CloudFormation template that allows you to change the value for the SNSTopic name for a new stack without having to create a new CloudFormation template, you can use the AMS Parameters section of the CloudFormation ingest change type to make that conﬁguration. By doing this, you use the same CloudFormation template later to create a new stack with a diﬀerent SNSTopic name. { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "My SNS Topic", "Parameters" : { }, "Resources" : { "SNSTopic" : { "Type" : "AWS::SNS::Topic", "Properties" : { "TopicName" : "MyTopicName" } } } } Example 2: Use an SNSTopic resource to reference a parameter in the AMS change type In this example, you use an SNSTopic resource TopicName property deﬁned in the CloudFormation template to reference a Parameter in the AMS change type. { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "My SNS Topic", "Parameters" : { "TopicName" : { "Type" : "String", "Description" : "Topic ID", "Default" : "MyTopicName" } }, "Resources" : { "SNSTopic" : { "Type" : "AWS::SNS::Topic", "Properties" : { "TopicName" : { "Ref" : "TopicName"} AWS CloudFormation Ingest: Examples Version September 13, 2024 88 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options } } } } Example 3: Create an SNS topic by submitting a JSON execution parameters ﬁle with the AMS ingest change type In this example, you submit a JSON execution parameters ﬁle with the AMS ingest CT that creates the SNS topic TopicName. The SNS topic must be deﬁned in the CloudFormation template in the modiﬁable way shown in this example. { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_PRESIGNED_URL", "VpcId": "VPC_ID", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], "Parameters": [ {"Name": "TopicName", "Value": "MyTopic1"} ], "TimeoutInMinutes": 60 } Example 4: Submit a new change type that references the same CloudFormation template This JSON example changes the SNS TopicName value without making a change to the CloudFormation template. Instead, you submit a new Deployment \| Ingestion \| Stack from CloudFormation Template \| Create change type that references the same CFN template. { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_PRESIGNED_URL", "VpcId": "VPC_ID", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], "Parameters": [ AWS CloudFormation Ingest: Examples Version September 13, 2024 89 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options {"Name": "TopicName", "Value": "MyTopic2"} ], "TimeoutInMinutes": 60 } Example 5: Use the default parameter values in the CloudFormation template In this example, the SNS TopicName = 'MyTopicName' is created because no TopicName value was provided in the Parameters execution parameter. If you don't provide Parameters deﬁnitions, the default parameter values in the CloudFormation template are used. { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_PRESIGNED_URL", "VpcId": "VPC_ID", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], "TimeoutInMinutes": 60 } CloudFormation Ingest examples: 3-tier Web application Ingest a CloudFormation template for a standard 3-Tier Web Application. AWS CloudFormation Ingest: Examples Version September 13, 2024 90 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options This includes an Application Load Balancer, Application Load Balancer target group, Auto Scaling group, Auto Scaling group launch template, Amazon Relational
ams-appguide-030	ams-appguide.pdf	30	in the Parameters execution parameter. If you don't provide Parameters deﬁnitions, the default parameter values in the CloudFormation template are used. { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_PRESIGNED_URL", "VpcId": "VPC_ID", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], "TimeoutInMinutes": 60 } CloudFormation Ingest examples: 3-tier Web application Ingest a CloudFormation template for a standard 3-Tier Web Application. AWS CloudFormation Ingest: Examples Version September 13, 2024 90 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options This includes an Application Load Balancer, Application Load Balancer target group, Auto Scaling group, Auto Scaling group launch template, Amazon Relational Database Service (RDS for SQL Server) with a MySQL database, AWS SSM Parameter store, and AWS Secrets Manager. Allow 30-60 minutes to walk through this example. Prerequisites • Create a secret containing a username and password with corresponding values using the AWS Secrets Manager. You can refer to this sample JSON template (zip ﬁle) that contains the secret name ams-shared/myapp/dev/dbsecrets, and replace it with your secret name. For information about using AWS Secrets Manager with AMS, see Using AWS Secrets Manager with AMS resources. AWS CloudFormation Ingest: Examples Version September 13, 2024 91 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Set up required parameters in the AWS SSM Parameter Store (PS). In this example, the VPCId and Subnet-Id of the Private and Public subnets are stored in the SSM PS in paths like /app/ DemoApp/PublicSubnet1a, PublicSubnet1c, PrivateSubnet1a, PrivateSubnet1c and VPCCidr. Update the paths and parameter names and values for your needs. • Create an IAM Amazon EC2 instance role with read permissions to the AWS Secrets Manager and SSM Parameter Store paths (the IAM role created and used in these examples is customer-ec2_secrets_manager_instance_profile). If you create IAM-standard policies like instance proﬁle role, the role name must start with customer-. To create a new IAM role, (you can name it customer-ec2_secrets_manager_instance_profile, or something else) use the AMS change type Management \| Applications \| IAM instance proﬁle \| Create (ct-0ixp4ch2tiu04) CT, and attach the required policies. You can review the AMS IAM standard policies, customer_secrets_manager_policy and customer_systemsmanager_parameterstore_policy, in the AWS IAM console to be used as-is or as a reference. Ingest a CloudFormation template for a standard 3-Tier Web application 1. Upload the attached sample CloudFormation JSON template as a zip ﬁle, 3-tier-cfn-ingest.zip to an S3 bucket and generate a signed S3 URL to use in the CFN Ingest RFC. For more information, see presign. The CFN template can also be copy/pasted into the CFN Ingest RFC when you submit the RFC through the AMS console. 2. Create a CloudFormation Ingest RFC (Deployment \| Ingestion \| Stack from CloudFormation template \| Create (ct-36cn2avfrrj9v)), either via the AMS console or the AMS CLI. The CloudFormation ingest automation process validates the CloudFormation template to ensure that the template has valid AMS-supported resources, and adheres to security standards. • Using the console - For the change type, select Deployment -> Ingestion -> Stack from CloudFormation Template -> Create, and then add the following parameters as an example (note that the default for MultiAZDatabase is false): CloudFormationTemplateS3Endpoint: "https://s3-ap- southeast-2.amazonaws.com/amzn-s3-demo-bucket/3-tier-cfn-ingest.json? AWSAccessKeyId=#{S3_ACCESS_KEY_ID}&Expires=#{EXPIRE_DATE}&Signature=#{SIGNATURE}" VpcId: "VPC_ID" TimeoutInMinutes: 120 IAMEC2InstanceProfile: "customer_ec2_secrets_manager_instance_profile" MultiAZDatabase: "true" AWS CloudFormation Ingest: Examples Version September 13, 2024 92 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options WebServerCapacity: "2" • Using the AWS CLI - For details about creating RFCs using the AWS CLI, see Creating RFCs. For example, run the following command: aws --profile=saml amscm create-rfc --change-type-id ct-36cn2avfrrj9v --change-type-version "2.0" --title "TEST_CFN_INGEST" --execution- parameters "{\"CloudFormationTemplateS3Endpoint\":\"https://s3- ap-southeast-2.amazonaws.com/my-bucket/3-tier-cfn-ingest.json? AWSAccessKeyId=#{S3_ACCESS_KEY_ID}&Expires=#{EXPIRE_DATE}&Signature=#{SIGNATURE}\", \"TimeoutInMinutes\":120,\"Description\":\"TEST\",\”VpcId”\”:\”VPC_ID\”, \"Name\":\"MY_TEST\",\"Tags\":[{\"Key\":\"env\",\"Value\":\"test\"}], \"Parameters\":[{\"Name\":\"IAMEC2InstanceProfile\",\"Value\": \"customer_ec2_secrets_manager_instance_profile\"},{\"Name\":\"MultiAZDatabase\", \"Value\":\"true\"},{\"Name\":\"VpcId\",\"Value\":\"VPC_ID\"},{\"Name\": \"WebServerCapacity\",\"Value\":\"2\"}]}" --endpoint-url https://amscm.us- east-1.amazonaws.com/operational/ --no-verify-ssl Find the Application Load Balancer URL in the AWS CloudFormation RFC execution output to access the website. For information about accessing resources, see Accessing instances. Create CloudFormation ingest stack Creating a CloudFormation ingest stack using the console To create a CloudFormation ingest stack using the console 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Create CloudFormation ingest stack Version September 13, 2024 93 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose
ams-appguide-031	ams-appguide.pdf	31	September 13, 2024 93 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CloudFormation ingest stack using the CLI To create a CloudFormation ingest stack using the CLI 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Create CloudFormation ingest stack Version September 13, 2024 94 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. 1. Prepare the CloudFormation template that you will use to create the stack, and upload it to your S3 bucket. For important details, see AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations. 2. Create and submit the RFC to AMS: • Create and save the execution parameters JSON ﬁle, include the CloudFormation template parameters that you want. The following example names it CreateCfnParams.json. Example Web application stack CreateCfnParams.json ﬁle: { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "VpcId": "VPC_ID", "CloudFormationTemplateS3Endpoint": "$S3_URL", "TimeoutInMinutes": 120, "Tags": [ { "Key": "Enviroment Type" "Value": "Dev", }, { "Key": "Application" "Value": "PCS", } ], "Parameters": [ Create CloudFormation ingest stack Version September 13, 2024 95 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "Name": "Parameter-for-S3Bucket-Name", "Value": "BUCKET-NAME" }, { "Name": "Parameter-for-Image-Id", "Value": "AMI-ID" } ], } Example SNS topic CreateCfnParams.json ﬁle: { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_URL", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], "Parameters": [ {"Name": "TopicName", "Value": "MyTopic1"} ] } 3. Create and save the RFC parameters JSON ﬁle with the following content. The following example names it CreateCfnRfc.json ﬁle: { "ChangeTypeId": "ct-36cn2avfrrj9v", "ChangeTypeVersion": "2.0", "Title": "cfn-ingest" } 4. Create the RFC, specifying the CreateCfnRfc ﬁle and the CreateCfnParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateCfnRfc.json --execution- parameters file://CreateCfnParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Create CloudFormation ingest stack Version September 13, 2024 96 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips Note This change type is at version 2.0 and is automated (not manually executed). This allows the CT execution to go more quickly, and, a new parameter, CloudFormationTemplate, allows you to paste into the RFC a custom CloudFormation template. Additionally, In this version, we do not attach the default AMS security groups if the you specify your own security groups. If
ams-appguide-032	ams-appguide.pdf	32	and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Create CloudFormation ingest stack Version September 13, 2024 96 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips Note This change type is at version 2.0 and is automated (not manually executed). This allows the CT execution to go more quickly, and, a new parameter, CloudFormationTemplate, allows you to paste into the RFC a custom CloudFormation template. Additionally, In this version, we do not attach the default AMS security groups if the you specify your own security groups. If you do not specify your own security groups in the request, AMS will attach the AMS default security groups. In CFN Ingest v1.0, we always appended the AMS default security groups whether or not you provided your own security groups. AMS has enabled 17 AMS Self-Provisioned services for use in this change type. For information about supported resources, see CloudFormation Ingest Stack: Supported Resources. Note Version 2.0 accepts an S3 endpoint that is not a presigned URL. If you use the previous version of this CT, the CloudFormationTemplateS3Endpoint parameter value must be a presigned URL. Example command for generating a presigned S3 bucket URL (Mac/Linux): export S3_PRESIGNED_URL=$(aws s3 presign DASHDASHexpires-in 86400 s3://BUCKET_NAME/CFN_TEMPLATE.json) Example command for generating a presigned S3 bucket URL (Windows): for /f %i in ('aws s3 presign DASHDASHexpires-in 86400 s3://BUCKET_NAME/CFN_TEMPLATE.json') do set S3_PRESIGNED_URL=%i See also Creating Pre-Signed URLs for Amazon S3 Buckets. Create CloudFormation ingest stack Version September 13, 2024 97 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note If the S3 bucket exists in an AMS account, you must use your AMS credentials for this command. For example, you may need to append --profile saml after obtaining your AMS AWS Security Token Service (AWS STS) credentials. Related change types: Approve a CloudFormation ingest stack changeset, Update AWS CloudFormation ingest stack To learn more about AWS CloudFormation, see AWS CloudFormation. To see CloudFormation templates, open the AWS CloudFormation Template Reference. Validating a AWS CloudFormation ingest The template is validated to ensure that it can be created in an AMS account. If it passes validation, it's updated to include any resources or conﬁgurations required for it to conform with AMS. This includes adding resources such as Amazon CloudWatch alarms in order to allow AMS Operations to monitor the stack. The RFC is rejected if any of the following are true: • RFC JSON Syntax is incorrect or does not follow the given format. • The provided S3 bucket presigned URL is not valid. • The template is not valid AWS CloudFormation syntax. • The template does not have defaults set for all parameter values. • The template fails AMS validation. For AMS validation steps, see the information later in this topic. The RFC fails if the CloudFormation stack fails to create due to a resource creation issue. To learn more about CFN validation and validator, see Template Validation and CloudFormation ingest stack: CFN validator examples. Create CloudFormation ingest stack Version September 13, 2024 98 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Update AWS CloudFormation ingest stack Updating a CloudFormation ingest stack using the console To update a CloudFormation Ingest Stack using the console 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Update AWS CloudFormation ingest stack Version September 13, 2024 99 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure
ams-appguide-033	ams-appguide.pdf	33	older version if applicable. Click Create RFC to open the Run RFC page. Update AWS CloudFormation ingest stack Version September 13, 2024 99 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Updating a CloudFormation ingest stack using the CLI To update a CloudFormation ingest stack using the CLI 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Update AWS CloudFormation ingest stack Version September 13, 2024 100 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. 1. Prepare the AWS CloudFormation template that you want to use to update the stack, and upload it to your S3 bucket. For important details, see AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations. 2. Create and submit the RFC to AMS: • Create and save the execution parameters JSON ﬁle, include the CloudFormation template parameters that you want. This example names it UpdateCfnParams.json. Example UpdateCfnParams.json ﬁle with inline parameter updates: { "StackId": "stack-yjjoo9aicjyqw4ro2", "VpcId": "VPC_ID", "CloudFormationTemplate": "{\"AWSTemplateFormatVersion\":\"2010-09-09\", \"Description\":\"Create a SNS topic\",\"Parameters\":{\"TopicName\":{\"Type \":\"String\"},\"DisplayName\":{\"Type\":\"String\"}},\"Resources\":{\"SnsTopic \":{\"Type\":\"AWS::SNS::Topic\",\"Properties\":{\"TopicName\":{\"Ref\": \"TopicName\"},\"DisplayName\":{\"Ref\":\"DisplayName\"}}}}}", "TemplateParameters": [ { "Key": "TopicName", "Value": "TopicNameCLI" }, { "Key": "DisplayName", "Value": "DisplayNameCLI" } ], "TimeoutInMinutes": 1440 } Example UpdateCfnParams.json ﬁle with S3 bucket endpoint containing an updated CloudFormation template: { "StackId": "stack-yjjoo9aicjyqw4ro2", "VpcId": "VPC_ID", Update AWS CloudFormation ingest stack Version September 13, 2024 101 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "CloudFormationTemplateS3Endpoint": "s3_url", "TemplateParameters": [ { "Key": "TopicName", "Value": "TopicNameCLI" }, { "Key": "DisplayName", "Value": "DisplayNameCLI" } ], "TimeoutInMinutes": 1080 } 3. Create and save the RFC parameters JSON ﬁle with the following content. This example names it UpdateCfnRfc.json ﬁle. { "ChangeTypeId": "ct-361tlo1k7339x", "ChangeTypeVersion": "1.0", "Title": "cfn-ingest-template-update" } 4. Create the RFC, specifying the UpdateCfnRfc ﬁle and the UpdateCfnParams ﬁle: aws amscm create-rfc --cli-input-json file://UpdateCfnRfc.json --execution- parameters file://UpdateCfnParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • This change type is now at version 2.0. Changes include removing the AutoApproveUpdateForResources parameter, which was used in version 1.0 of this CT, and adding two new parameters: AutoApproveRiskyUpdates and BypassDriftCheck. • If the S3 bucket exists in an AMS account, you must use your AMS credentials for this command. For example, you may need to append --profile saml after obtaining your AMS AWS Security Token Service (AWS STS) credentials. Update AWS CloudFormation ingest stack Version September 13, 2024 102 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • All Parameter values for resources in the CloudFormation template must have a value, either through a default or a custom value through the parameters section of the CT. You can override the parameter value by structuring the CloudFormation template resources to reference a Parameters key. For examples that show how to do, see CloudFormation ingest stack: CFN validator examples. IMPORTANT: Missing parameters not supplied explicitly in the form, default to the currently set values on the existing stack or template. • For a list of which self-provisioned services you can add using AWS CloudFormation
ams-appguide-034	ams-appguide.pdf	34	AMS Advanced Application Deployment Options • All Parameter values for resources in the CloudFormation template must have a value, either through a default or a custom value through the parameters section of the CT. You can override the parameter value by structuring the CloudFormation template resources to reference a Parameters key. For examples that show how to do, see CloudFormation ingest stack: CFN validator examples. IMPORTANT: Missing parameters not supplied explicitly in the form, default to the currently set values on the existing stack or template. • For a list of which self-provisioned services you can add using AWS CloudFormation Ingest, see CloudFormation Ingest Stack: Supported Resources. To learn more about AWS CloudFormation, see AWS CloudFormation. Validating a AWS CloudFormation ingest The template is validated to ensure that it can be created in an AMS account. If it passes validation, it's updated to include any resources or conﬁgurations required for it to conform with AMS. This includes adding resources such as Amazon CloudWatch alarms in order to allow AMS Operations to monitor the stack. The RFC is rejected if any of the following are true: • RFC JSON Syntax is incorrect or does not follow the given format. • The provided S3 bucket presigned URL is not valid. • The template is not valid AWS CloudFormation syntax. • The template does not have defaults set for all parameter values. • The template fails AMS validation. For AMS validation steps, see the information later in this topic. The RFC fails if the CloudFormation stack fails to create due to a resource creation issue. To learn more about CFN validation and validator, see Template Validation and CloudFormation ingest stack: CFN validator examples. Update AWS CloudFormation ingest stack Version September 13, 2024 103 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Approve a CloudFormation ingest stack changeset Approving and updating a CloudFormation ingest stack using the console To approve and update a CloudFormation ingest stack using the console 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Approve a CloudFormation ingest stack changeset Version September 13, 2024 104 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Approving and updating a CloudFormation ingest stack using the CLI To approve and update a CloudFormation ingest stack using the CLI 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to
ams-appguide-035	ams-appguide.pdf	35	included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Approve a CloudFormation ingest stack changeset Version September 13, 2024 105 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Output the execution parameters JSON schema for this change type to a ﬁle in your current folder. This example names it CreateAsgParams.json: aws amscm create-rfc --change-type-id "ct-1404e21baa2ox" --change- type-version "1.0" --title "Approve Update" --execution-parameters file://PATH_TO_EXECUTION_PARAMETERS --profile saml 2. Modify and save the schema as follows: { "StackId": "STACK_ID", "VpcId": "VPC_ID", "ChangeSetName": "UPDATE-ef81e2bc-03f6-4b17-a3c7-feb700e78faa", "TimeoutInMinutes": 1080 } Tips Note If there are multiple resources in a stack, and you want to delete only a subset of the stack resources, use the CloudFormation Update CT; see CloudFormation Ingest Stack: Updating. You can also submit a Management \| Other \| Other \| Update change type and AMS engineers can help you craft the changeset, if needed. To learn more about AWS CloudFormation, see AWS CloudFormation. Update AWS CloudFormation stacks termination protection Updating an AWS CloudFormation termination protection stack with the console The following shows this change type in the AMS console. Update AWS CloudFormation stacks termination protection Version September 13, 2024 106 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Update AWS CloudFormation stacks termination protection Version September 13, 2024 107 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Updating an AWS CloudFormation stack termination protection with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to
ams-appguide-036	ams-appguide.pdf	36	included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Only specify the parameters you want to change. Absent parameters retain the existing values. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Update AWS CloudFormation stacks termination protection Version September 13, 2024 108 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc \ --change-type-id "ct-2uzbqr7x7mekd" \ --change-type-version "1.0" \ --title "Enable termination protection on CFN stack" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- ManageResourceTerminationProtection\",\"Region\":\"us-east-1\",\"Parameters\": {\"ResourceId\":[\"stack-psvnq6cupymio3enl\"],\"TerminationProtectionDesiredState\": [\"enabled\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it EnableTermProCFNParams.json: aws amscm get-change-type-version --change-type-id "ct-2uzbqr7x7mekd" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EnableTermProCFNParams.json 2. Modify and save the EnableTermProCFNParams ﬁle, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-ManageResourceTerminationProtection", "Region": "us-east-1", "Parameters": { "ResourceId": ["stack-psvnq6cupymio3enl"], "TerminationProtectionDesiredState": ["enabled"] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it EnableTermProCFNRfc.json: aws amscm create-rfc --generate-cli-skeleton > EnableTermProCFNRfc.json 4. Modify and save the EnableTermProCFNRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2uzbqr7x7mekd", "ChangeTypeVersion": "1.0", Update AWS CloudFormation stacks termination protection Version September 13, 2024 109 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Title": "Enable termination protection on CFN instance" } 5. Create the RFC, specifying the EnableTermProCFNRfc ﬁle and the EnableTermProCFNParams ﬁle: aws amscm create-rfc --cli-input-json file://EnableTermProCFNRfc.json --execution- parameters file://EnableTermProCFNParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note There is a related CT for Amazon EC2, EC2 stack: Updating termination protection. To learn more about termination protection, see Protecting a stack from being deleted. Automated IAM deployments using CFN ingest or stack update CTs in AMS You can use these AMS change types to deploy IAM roles (the AWS::IAM::Role resource) in both multi-account landing zone (MALZ) and single-account landing zone (SALZ): • Deployment \| Ingestion \| Stack from CloudFormation Template \| Create (ct-36cn2avfrrj9v) • Management \| Custom Stack \| Stack From CloudFormation Template \| Update (ct-361tlo1k7339x) • Management \| Custom Stack \| Stack From CloudFormation Template \| Approve and Update (ct-1404e21baa2ox) Validations performed on the IAM roles in your CFN template: • ManagedPolicyArns: The attribute ManagedPolicyArns must not exist in AWS::IAM::Role. The validation disallows attaching managed policies to the role being provisioned. Instead, the permissions for the role can be managed using the inline policy through the property Policies. Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 110 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • PermissionsBoundary: The policy used to set the permissions boundary for the role can only be the AMS vended managed policy: AWSManagedServices_IAM_PermissionsBoundary. This policy acts as a guard rail that protects the AMS infrastructure resources from being modiﬁed using the role being provisioned. With this default permissions boundary, the security beneﬁts that AMS provides are preserved. The AWSManagedServices_IAM_PermissionsBoundary (the default) is required, without it, the request is rejected. • MaxSessionDuration: The maximum session duration that can be set for the IAM role is 1 to 4 hours. AMS technical standard require a customer risk acceptance for session duration beyond 4 hours. • RoleName: The following namespaces are preserved by AMS and cannot be used as IAM role name preﬁxes: AmazonSSMRole, AMS, Ams, ams, AWSManagedServices, customer_developer_role, customer-mc-, Managed_Services, MC, Mc, mc, SENTINEL, Sentinel, sentinel, StackSet-AMS, StackSet-Ams, StackSet-ams, StackSet-AWS, StackSet-MC, StackSet-Mc, StackSet-mc • Policies: The inline policy embedded in the IAM role can only include a set of IAM actions that are pre-approved by AMS. This is the upper bound of all IAM actions allowed to create an IAM role with (control policy). The
ams-appguide-037	ams-appguide.pdf	37	is 1 to 4 hours. AMS technical standard require a customer risk acceptance for session duration beyond 4 hours. • RoleName: The following namespaces are preserved by AMS and cannot be used as IAM role name preﬁxes: AmazonSSMRole, AMS, Ams, ams, AWSManagedServices, customer_developer_role, customer-mc-, Managed_Services, MC, Mc, mc, SENTINEL, Sentinel, sentinel, StackSet-AMS, StackSet-Ams, StackSet-ams, StackSet-AWS, StackSet-MC, StackSet-Mc, StackSet-mc • Policies: The inline policy embedded in the IAM role can only include a set of IAM actions that are pre-approved by AMS. This is the upper bound of all IAM actions allowed to create an IAM role with (control policy). The control policy consists of: Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 111 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • All actions in the AWS managed policy ReadOnlyAccess that provides read-only access to all AWS services and resources • The following actions, with the restriction on cross-account S3 actions i.e. allowed S3 actions can only be performed on resources present in the same account as the role being created: amscm:, amsskms:, lambda:InvokeFunction, logs:CreateLogStream, logs:PutLogEvents, s3:AbortMultipartUpload, s3:DeleteObject, s3:DeleteObjectVersion, s3:ObjectOwnerOverrideToBucketOwner, s3:PutObject, s3:ReplicateTags, secretsmanager:GetRandomPassword, sns:Publish Any IAM role created or updated through CFN ingest can allow actions listed on this control policy, or actions that are scoped down from (less permissive than) the actions listed on the control policy. Currently we allow these safe IAM actions that can be categorized as readonly actions, plus the above mentioned non-readonly actions that can't be accomplished through CTs and are pre-approved per AMS technical standard. • AssumeRolePolicyDocument: The following entities are pre-approved and can be included in the trust policy to assume the role being created: • Any IAM entity (role, user, root user, STS assumed-role session) in the same account can assume the role. • The following AWS services can assume the role: apigateway.amazonaws.com, autoscaling.amazonaws.com, cloudformation.amazonaws.com, codebuild.amazonaws.com, codedeploy.amazonaws.com, codepipeline.amazonaws.com, datapipeline.amazonaws.com, datasync.amazonaws.com, dax.amazonaws.com, Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 112 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options dms.amazonaws.com, ec2.amazonaws.com, ecs-tasks.amazonaws.com, ecs.application-autoscaling.amazonaws.com, elasticmapreduce.amazonaws.com, es.amazonaws.com, events.amazonaws.com, firehose.amazonaws.com, glue.amazonaws.com, lambda.amazonaws.com, monitoring.rds.amazonaws.com, pinpoint.amazonaws.com, rds.amazonaws.com, redshift.amazonaws.com, s3.amazonaws.com, sagemaker.amazonaws.com, servicecatalog.amazonaws.com, sns.amazonaws.com, ssm.amazonaws.com, states.amazonaws.com, storagegateway.amazonaws.com, transfer.amazonaws.com, vmie.amazonaws.com • The SAML provider in the same account can assume the role. Currently, the only supported SAML provider name is customer-saml. If one or more of the validations fail, the RFC is rejected. A sample RFC rejection reason look like this: {"errorMessage":"[ 'LambdaRole: The maximum session duration (in seconds) should be a numeric value in the range 3600 to 14400 (i.e. 1 to 4 hours).', 'lambda-policy: Policy document is too permissive.']","errorType":"ClientError"} If you need assistance with a failed RFC validation or execution, use the RFC correspondence to reach out to AMS. For instructions, see RFC correspondence and attachment (console). For any other questions, submit a service request. For a how-to, see Creating a Service Request. Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 113 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note We do not currently enforce any IAM best practices as part of our IAM validations. For IAM best practices, see Security best practices in IAM. Creating IAM roles with more permissive actions or enforcing IAM best practices Create your IAM entities with the following manual change types: • Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create entity or policy (ct-3dpd8mdd9jn1r) • Management \| Advanced stack components \| Identity and Access Management (IAM) \| Update entity or policy (ct-27tuth19k52b4) We recommend that you read and understand our technical standards before ﬁling these manual RFCs. For access, see How to access technical standards. Note Each IAM role directly created with these manual change types belongs to its own individual stack and does not reside in the same stack where the other infrastructure resources are created through CFN Ingest CT. Updating IAM Roles created with CFN ingest through manual change types when updates cannot be done through automated change types Use the Management \| Advanced stack components \| Identity and Access Management (IAM) \| Update entity or policy (ct-27tuth19k52b4) change type. Important Updates on IAM roles through the manual CT are not reﬂected in the CFN stack templates and cause stack drift. Once the role has been updated through a manual request to a state that doesn’t pass our validations, the role cannot be further updated using the Stack Update CT (ct-361tlo1k7339x) again as long as it continues to be non-compliant with our validations. The update CT can be used only if the CFN stack template is compliant Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 114 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options with our validations. However, the stack can still be
ams-appguide-038	ams-appguide.pdf	38	reﬂected in the CFN stack templates and cause stack drift. Once the role has been updated through a manual request to a state that doesn’t pass our validations, the role cannot be further updated using the Stack Update CT (ct-361tlo1k7339x) again as long as it continues to be non-compliant with our validations. The update CT can be used only if the CFN stack template is compliant Automated IAM deployments using CFN ingest or stack update CTs Version September 13, 2024 114 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options with our validations. However, the stack can still be updated via the Stack Update CT (ct-361tlo1k7339x), as long as the IAM resource that’s non-compliant with our validations is not being updated and the CFN template passes our validations. Deleting your IAM roles created through AWS CloudFormation ingest If you want to delete the whole stack, use the following automated Delete Stack change type. For instructions, see Delete Stack: • Change Type ID: ct-0q0bic0ywqk6c • Classiﬁcation: Management \| Standard stacks \| Stack \| Delete and Management \| Advanced stack components \| Stack \| Delete If you want to delete an IAM role without deleting the whole stack, you can remove the IAM role from the CloudFormation template and use the updated template as an input to the automated Stack Update change type: • Change Type ID: ct-361tlo1k7339x • Classiﬁcation: Management \| Custom stack \| Stack from CloudFormation template \| Update For instructions, see Update AWS CloudFormation ingest stack. CodeDeploy requests You can use AWS CodeDeploy to create application containers that you can then deploy through a CodeDeploy application group. For more information about CodeDeploy, see AWS CodeDeploy Documentation. Working with AWS CodeDeploy involves the following process: 1. Create a CodeDeploy application. The CodeDeploy application is a name or container used by CodeDeploy to ensure that the correct revision, deployment conﬁguration, and deployment group are referenced during a deployment. 2. Create a CodeDeploy deployment group. A CodeDeploy deployment group deﬁnes a set of individual instances targeted for a deployment. AMS has a separate change type for CodeDeploy deployment groups for EC2. CodeDeploy requests Version September 13, 2024 115 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. Deploy the CodeDeploy application through the CodeDeploy deployment group. CodeDeploy application Create or deploy CodeDeploy applications. Create CodeDeploy application Creating a CodeDeploy application with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. CodeDeploy application Version September 13, 2024 116 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy application with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID
ams-appguide-039	ams-appguide.pdf	39	Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy application with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status CodeDeploy application Version September 13, 2024 117 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-0ah3gwb9seqk2" --change-type-version "1.0" --title "Stack-Create-CD-App" --execution-parameters "{\"Description\":\"TestCdApp\", \"VpcId\":\"VPC_ID\",\"StackTemplateId\":\"stm-sft6rv00000000000\",\"Name\":\"Test\", \"TimeoutInMinutes\":60,\"Parameters\":{\"CodeDeployApplicationName\":\"Test\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for the CodeDeploy application CT to a ﬁle in your current folder; this example names it CreateCDAppParams.json: aws amscm get-change-type-version --change-type-id "ct-0ah3gwb9seqk2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDAppParams.json 2. Modify and save the JSON ﬁle as follows. For example, you can replace the contents with something like this: { "Description": "Create WP CodeDeploy App", "VpcId": "VPC_ID", "StackTemplateId": "stm-sft6rv00000000000", "Name": "WpCDApp", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; this example names it CreateCDAppRfc.json: CodeDeploy application Version September 13, 2024 118 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --generate-cli-skeleton > CreateCDAppRfc.json 4. Modify and save the JSON ﬁle as follows. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0ah3gwb9seqk2", "Title": "CD-App-Stack-RFC" } 5. Create the RFC, specifying the CreateCDAppRfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDAppRfc.json --execution- parameters file://CreateCDAppParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy, see Create an Application with AWS CodeDeploy. Deploy CodeDeploy application Deploying a CodeDeploy application with the console CodeDeploy application Version September 13, 2024 119 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh
ams-appguide-040	ams-appguide.pdf	40	CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Deploying a CodeDeploy application with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. CodeDeploy application Version September 13, 2024 120 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2edc3sd1sqmrb" --change- type-version "2.0" --title "Stack-Deploy-CD-App" --execution- parameters "{\"Description\":\"MyCDAppDeployTest\",\"VpcId\": \"VPC_ID\",\"Name\":\"Test\",\"TimeoutInMinutes\":60,\"Parameters\": {\"CodeDeployApplicationName\":\"TestCDApp\",\"CodeDeployDeploymentConfigName\": \"CodeDeployDefault.OneAtATime\",\"CodeDeployDeploymentGroupName\":\"TestCDDepGroup\", \"CodeDeployIgnoreApplicationStopFailures\":false,\"CodeDeployRevision\": {\"RevisionType\":\"S3\",\"S3Location\":{\"S3Bucket\":\"amzn-s3-demo-bucket\", \"S3BundleType\":\"tar\",\"S3Key\":\"TestKey\"}}}}"Test\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for the CodeDeploy application deployment CT; this example names it DeployCDAppParams.json: CodeDeploy application Version September 13, 2024 121 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm get-change-type-version --change-type-id "ct-2edc3sd1sqmrb" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployCDAppParams.json 2. Modify the JSON ﬁle as follows. For example, you can replace the contents with something like this: { "Description": "Deploy WordPress CodeDeploy Application", "VpcId": "VPC_ID", "Name": "WP CodeDeploy Deployment Group", "TimeoutInMinutes": 360, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployDeploymentGroupName": "WordPressCDDepGroup", "CodeDeployIgnoreApplicationStopFailures": false, "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "amzn-s3-demo-bucket", "S3BundleType": "zip", "S3Key": "wordpress.zip" } } } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; this example names it DeployCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployCDAppRfc.json 4. Modify and save the DeployCDAppRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2edc3sd1sqmrb", "Title": "CD-Deploy-For-CD-APP-Stack-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the DeployCDAppRfc ﬁle: CodeDeploy application Version September 13, 2024 122 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --cli-input-json file://DeployCDAppRfc.json --execution- parameters file://DeployCDAppParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information, see Create a deployment with CodeDeploy. CodeDeploy deployment groups Create CodeDeploy application groups. Create CodeDeploy deployment group Creating a CodeDeploy deployment group with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. CodeDeploy deployment groups Version September 13, 2024 123 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the
ams-appguide-041	ams-appguide.pdf	41	Application Deployment Options • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy deployment group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: CodeDeploy deployment groups Version September 13, 2024 124 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2gd0u847qd9d2" --change-type-version "1.0" --title "Stack-Create-CD-Dep-Group" --execution-parameters "{\"Description \":\"TestCdDepGroupRfc\",\"VpcId\":\"VPC_ID\",\"StackTemplateId\":\"stm- sp9lrk00000000000\",\"Name\":\"MyTestCDDepGroup\",\"TimeoutInMinutes\":60,\"Parameters \":{\"CodeDeployApplicationName\":\"TestCDApp\",\"CodeDeployAutoScalingGroups\": [\"TestASG\"],\"CodeDeployDeploymentConfigName\":\"CodeDeployDefault.OneAtATime\", \"CodeDeployDeploymentGroupName\":\"Test\",\"CodeDeployServiceRoleArn\": \"arn:aws:iam::000000000:role/aws-codedeploy-role\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a ﬁle in your current folder; this example names it CreateCDDepGroupParams.json: aws amscm get-change-type-version --change-type-id "ct-2gd0u847qd9d2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDDepGroupParams.json 2. Modify and save the JSON ﬁle. For example, you can replace the contents with something like this: CodeDeploy deployment groups Version September 13, 2024 125 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "Description": "CreateCDDeploymentGroup", "VpcId": "VPC_ID", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "WordPressCDAppGroup", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployAutoScalingGroups": ["ASG_NAME"], "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; this example names it CreateCDDepGroupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupRfc.json 4. Modify and save the JSON ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2gd0u847qd9d2", "Title": "CD-Dep-Group-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupRfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupRfc.json --execution- parameters file://CreateCDDepGroupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. CodeDeploy deployment groups Version September 13, 2024 126 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. Create CodeDeploy deployment group for EC2 Creating a CodeDeploy deployment group for EC2 with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in
ams-appguide-042	ams-appguide.pdf	42	remains in the editing state and does not start. CodeDeploy deployment groups Version September 13, 2024 126 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. Create CodeDeploy deployment group for EC2 Creating a CodeDeploy deployment group for EC2 with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. CodeDeploy deployment groups Version September 13, 2024 127 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy deployment group for EC2 with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status CodeDeploy deployment groups Version September 13, 2024 128 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-00tlkda4242x7" --change-type- version "1.0" --title "Stack-Create-CD-Ec2-Dep-Group" --execution-parameters "{\"Description\":\"MyTestCdDepEc2DepGroup\",\"VpcId\":\"VPC_ID\",\"Name\": \"TestCDDepEc2Group\",\"StackTemplateId\":\"stm-n3hsoirgqeqqdbpk2\",\"TimeoutInMinutes \":60,\"Parameters\":{\"ApplicationName\":\"TestCDApp\",\"DeploymentConfigName\": \"CodeDeployDefault.OneAtATime\",\"AutoRollbackEnabled\":\"False\",\"EC2FilterTag\": \"Name=Test\",\"EC2FilterTag2\":\"\",\"EC2FilterTag3\":\"\",\"ServiceRoleArn\":\"\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a ﬁle; this example names it CreateCDDepGroupEc2Params.json: aws amscm get-change-type-version --change-type-id "ct-00tlkda4242x7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDDepGroupEc2Params.json 2. Modify and save the JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "CreateCDDepGroupEc2", "VpcId": "VPC_ID", "StackTemplateId": "stm-n3hsoirgqeqqdbpk2", "Name": "CDAppGroupEc2", "TimeoutInMinutes": 60, "Parameters": { "ApplicationName": "CDAppEc2", "DeploymentConfigName": "CodeDeployDefault.OneAtATime", CodeDeploy deployment groups Version September 13, 2024 129 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; this example names it CreateCDDepGroupEc2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupEc2Rfc.json 4. Modify and save the JSON ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-00tlkda4242x7", "Title": "CD-Dep-Group-For-Ec2-Stack-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupEc2Rfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupEc2Rfc.json -- execution-parameters file://CreateCDDepGroupEc2Params.json You
ams-appguide-043	ams-appguide.pdf	43	"DeploymentConfigName": "CodeDeployDefault.OneAtATime", CodeDeploy deployment groups Version September 13, 2024 129 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; this example names it CreateCDDepGroupEc2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupEc2Rfc.json 4. Modify and save the JSON ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-00tlkda4242x7", "Title": "CD-Dep-Group-For-Ec2-Stack-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupEc2Rfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupEc2Rfc.json -- execution-parameters file://CreateCDDepGroupEc2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. AWS Database Migration Service (AWS DMS) AWS Database Migration Service (AWS DMS) helps you migrate databases to AMS easily and securely. You can migrate your data to and from most widely used commercial and open-source databases, such as Oracle, MySQL, and PostgreSQL. The service supports homogeneous migrations such as Oracle to Oracle, and also heterogeneous migrations between diﬀerent database AWS Database Migration Service (AWS DMS) Version September 13, 2024 130 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options platforms, such as Oracle to PostgreSQL or MySQL to Oracle. AWS DMS is an AWS service; the AMS CTs help you create AWS DMS resources in your AMS-managed account The following graphic depicts the workﬂow of an database migration. Topics • AWS Database Migration Service (AWS DMS), before you begin • AWS DMS, required data for setup • AWS DMS setup tasks • AWS DMS management AWS Database Migration Service (AWS DMS), before you begin When planning a database migration using the AMS AWS DMS, consider the following: • Source and target endpoints: You need to know what information and tables in the source database need to be migrated to the target database. AMS AWS DMS supports basic schema migration, including the creation of tables and primary keys. However, AMS AWS DMS doesn't automatically create secondary indexes, foreign keys, accounts, and so on in the target database. See Sources for Data Migration and Targets for Data Migration for more information. • Schema/Code Migration: AMS AWS DMS doesn't perform schema or code conversion. You can use tools such as Oracle SQL Developer, MySQL Workbench, or pgAdmin III to convert your schema. If you want to convert an existing schema to a diﬀerent database engine, you can use the AWS Schema Conversion Tool. It can create a target schema and also can generate and create an entire schema: tables, indexes, views, and so on. You can also use the tool to convert PL/SQL or TSQL to PgSQL and other formats. Planning for AWS DMS Version September 13, 2024 131 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Unsupported data types: Some source data types need to be converted into the equivalent data types for the target database. AWS DMS scenarios to consider The following, documented, scenarios might help you craft your own database migration path. • Migrate data from an on-prem MySQL server to Amazon RDS MySQL: See AWS blog post Migrate On-Premises MySQL Data to Amazon RDS (and back) • Migrate data from an Oracle database to Amazon RDS Aurora PostgreSQL database: See AWS blog post A quick introduction to migrating from an Oracle database to an Amazon Aurora PostgreSQL database • Migrate data from RDS MySQL to S3: See AWS blog post How to archive data from relational databases to Amazon Glacier using AWS DMS For a database migration, you must do the following: • Plan your database migration, this includes setting up a replication subnet group. • Allocate a replication instance that performs all the processes for the migration. • Specify a source and a target database endpoint. • Create a task or set of tasks to deﬁne what tables and replication processes you want to use. • Create the AWS DMS IAM dms-cloudwatch-logs-role and dms-vpc-role roles. If you use Amazon Redshift as a target database, you must also create and add the IAM role dms-access- for-endpoint to your AWS account. For more information, see Creating the IAM roles to use with the AWS CLI and AWS DMS API. These walkthroughs provide an example of using the AMS console or AMS CLI to create an AWS Database Migration Service (AWS DMS). CLI commands for creating the AWS DMS replication instance, subnet group, and task as well as an AWS DMS source endpoint and target endpoint are provided. To learn more about AMS AWS DMS, see AWS Database Migration Service for general information and AWS
ams-appguide-044	ams-appguide.pdf	44	target database, you must also create and add the IAM role dms-access- for-endpoint to your AWS account. For more information, see Creating the IAM roles to use with the AWS CLI and AWS DMS API. These walkthroughs provide an example of using the AMS console or AMS CLI to create an AWS Database Migration Service (AWS DMS). CLI commands for creating the AWS DMS replication instance, subnet group, and task as well as an AWS DMS source endpoint and target endpoint are provided. To learn more about AMS AWS DMS, see AWS Database Migration Service for general information and AWS Database Migration Service FAQs for answers to common questions. Planning for AWS DMS Version September 13, 2024 132 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AWS DMS, required data for setup For each of the following AWS DMS walkthroughs, some data in common is needed. • Description: Meaningful information about the resource, this is separate from other parameter Description options. • VpcId: The VPC to use. You can ﬁnd this out by running the ListVpcSummaries operation of the SKMS API (list-vpc-summaries in the CLI) or by looking on the VPCs page in the AMS Console. For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. • Name: A name for the stack or stack component; this becomes the Stack Name. • TimeoutInMinutes: How many minutes are allowed for the creation of the stack before the RFC is failed. This setting will not delay the RFC execution, but you must give enough time (for example, don't specify "5"). • ChangeTypeId, ChangeTypeVersion, and StackTemplateId: These are required but vary per CT and their values are provided in each relevant section, following. AWS DMS setup tasks Set up AWS DMS with the following walkthroughs. 1: AWS DMS replication subnet group: Create You can use the AMS console or API/CLI to create an AMS AWS DMS replication subnet group. Required data for AWS DMS setup Version September 13, 2024 133 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Create AWS DMS replication subnet group Creating a AWS DMS replication subnet group with the console Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Tasks for AWS DMS setup Version September 13, 2024 134 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a AWS DMS replication subnet group with the CLI Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID
ams-appguide-045	ams-appguide.pdf	45	of it with the options at the top of the page. Creating a AWS DMS replication subnet group with the CLI Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Tasks for AWS DMS setup Version September 13, 2024 135 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2q5azjd8p1ag5" --change-type-version "1.0" --title "TestDMSRepSG" --execution- parameters "{\"Description\":\"DMSTestRepSG\",\"VpcId\":\"VPC-ID\",\"Name\":\"Test Stack\",\"Parameters\":{\"Description\":\"DESCRIPTION\",\"SubnetIds\":[\"SUBNET-ID\", \"SUBNET-ID\"]},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm-j637f96ls1h4oy5fj \"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRsgParams.json: aws amscm get-change-type-version --change-type-id "ct-2q5azjd8p1ag5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRsgParams.json 2. Modify and save the execution parameters CreateDmsRsgParams.json ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepSG", "VpcId": "VPC_ID", "TimeoutInMinutes": 60, "StackTemplateId": "stm-j637f96ls1h4oy5fj", "Name": "Test RSG", Tasks for AWS DMS setup Version September 13, 2024 136 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Parameters": { "Description": "DESCRIPTION", "SubnetIds": ["SUBNET_ID", "SUBNET_ID"] } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRsgRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRsgRfc.json 4. Modify and save the CreateDmsRsgRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2q5azjd8p1ag5", "Title": "DMS-RSG-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRsgRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRsgRfc.json --execution- parameters file://CreateDmsRsgParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • This CT fails if the dms-vpc-role IAM role doesn't exist in the account. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. For more information about DMS replication instances and subnet groups, see Setting Up a Network for a Replication Instance. 2: AWS DMS replication instance: Create You can use the AMS console or API/CLI to create an AMS AWS DMS replication instance. Tasks for AWS DMS setup Version September 13, 2024 137 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Create AWS DMS replication instance Creating a AWS DMS replication instance with the console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse
ams-appguide-046	ams-appguide.pdf	46	select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Tasks for AWS DMS setup Version September 13, 2024 138 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a AWS DMS replication instance with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Tasks for AWS DMS setup Version September 13, 2024 139 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-27apldkhqr0ol" --change-type-version "1.0" --title "TestDMSRepInstance" -- execution-parameters "{\"Description\":\"DMSTestRepInstance\",\"VpcId\":\"VPC-ID\", \"Name\":\"REP-INSTANCE-NAME\",\"Parameters\":{\"InstanceClass\":\"dms.t2.micro\", \"ReplicationSubnetGroupIdentifier\":\"TEST-REP-SG\",\"SecurityGroupIds\":\"SG-ID, SG- ID\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm-3n1j5hdrmiiiuqk6v\"}" While your replication instance is being created, you can specify the source and target data stores. The source and target data stores can be on an Amazon Elastic Compute Cloud (Amazon EC2) instance, an AWS S3 Bucket, an Amazon Relational Database Service (Amazon RDS) DB instance, or an on-premises database. TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRiParams.json: aws amscm get-change-type-version --change-type-id "ct-27apldkhqr0ol" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRiParams.json 2. Modify and save the execution parameters CreateDmsRiParams.json ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepInstance", "VpcId": "VPC_ID", "Name": "Test RI", "StackTemplateId": "stm-3n1j5hdrmiiiuqk6v", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "InstanceClass": "dms.t2.micro", "ReplicationSubnetGroupIdentifier": "TEST-REP-SG", "SecurityGroupIds": ["SG-ID, SG-ID"} } Tasks for AWS DMS setup Version September 13, 2024 140 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRiRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRiRfc.json 4. Modify and save the CreateDmsRiRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-27apldkhqr0ol", "Title": "DMS-RI-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRiRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRiRfc.json --execution- parameters file://CreateDmsRiParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. • You must create a replication instance on an EC2 instance in your AMS VPC that has suﬃcient storage and processing power to perform the tasks you assign and migrate data from your source database to the target database. The required size of this instance varies depending on the amount of data you need
ams-appguide-047	ams-appguide.pdf	47	response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. • You must create a replication instance on an EC2 instance in your AMS VPC that has suﬃcient storage and processing power to perform the tasks you assign and migrate data from your source database to the target database. The required size of this instance varies depending on the amount of data you need to migrate and the tasks that you need the instance to perform. The replication instance provides high availability and failover support using a Multi- AZ deployment when you select the MultiAZ option. For more information about replication instances, see Working with an AWS DMS Replication Instance. 3: AWS DMS source endpoint: Create, create for Mongo DB, create for S3 You can use the AMS console or API/CLI to create an AMS DMS source endpoint for various databases, we provide three examples. Tasks for AWS DMS setup Version September 13, 2024 141 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options DMS source endpoint: creating Creating a DMS Source Endpoint with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Tasks for AWS DMS setup Version September 13, 2024 142 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Tasks for AWS DMS setup Version September 13, 2024 143 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --title "MariaDB-DMS- Source-Endpoint" --aws-account-id ACCOUNT-ID --change-type-id ct-0attesnjqy2cx
ams-appguide-048	ams-appguide.pdf	48	\" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Tasks for AWS DMS setup Version September 13, 2024 143 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --title "MariaDB-DMS- Source-Endpoint" --aws-account-id ACCOUNT-ID --change-type-id ct-0attesnjqy2cx -- change-type-version 1.0 --execution-parameters "{\"Description\":\"DESCRIPTION.\", \"VpcId\":\"VPC-ID\",\"Name\":\"MariaDB-DMS-SE\",\"Parameters\":{\"EngineName\": \"mariadb\",\"ServerName\":\"mariadb.db.example.com\",\"Port\":3306,\"Username\": \"DB-USER\",\"Password\":\"DB-PW\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm- pud4ghhkp7395n9bc\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeParams.json. aws amscm get-change-type-version --change-type-id "ct-0attesnjqy2cx" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "MariaDB-DMS-SE", "VpcId": "VPC_ID", "Name": "Test SE", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "EngineName": "mariadb", "ServerName": "mariadb.db.example.com", "Port": "3306", "Username": "DB-USER", "Password": "DB-PW",} } } Tasks for AWS DMS setup Version September 13, 2024 144 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeRfc.json 4. Modify and save the CreateDmsSeRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0attesnjqy2cx", "Title": "MariaDB-DMS-Source-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeRfc.json --execution- parameters file://CreateDmsSeParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Before you create the DMS endpoint, make sure that your password doesn't contain unsupported characters. For more information, see Creating source and target endpoints in the AWS Database Migration Service User Guide. To learn more, see Sources for Data Migration. For an S3 source endpoint, see DMS source endpoint for S3: creating. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. DMS source endpoint for MongoDB: Creating Creating a DMS Mongo DB Source Endpoint with the Console Screenshot of this change type in the AMS console: Tasks for AWS DMS setup Version September 13, 2024 145 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Tasks for AWS DMS setup Version September 13, 2024 146 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS Mongo DB Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for
ams-appguide-049	ams-appguide.pdf	49	are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS Mongo DB Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Tasks for AWS DMS setup Version September 13, 2024 147 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm --profile saml --region us-east-1 create-rfc --change-type-id "ct-2hxcllf1b4ey0" --change-type-version "1.0" --title 'DMS_Source_MongoDB' --description "DESCRIPTION" --execution-parameters "{\"Description\": \"DMS_MongoDB_Source_Endpoint\",\"VpcId\":\"VPC_ID\",\"Name\":\"DMS-Mongo-SE\", \"StackTemplateId\":\"stm-pud4ghhkp7395n9bc\",\"TimeoutInMinutes\":60,\"Parameters\": {\"DatabaseName\":\"mytestdb\",\"EngineName\":\"mongodb\",\"Port\":27017,\"ServerName \":\"test.example.com\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeMongoParams.json. aws amscm get-change-type-version --change-type-id "ct-2hxcllf1b4ey0" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeMongoParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "MongoDB-DMS-SE", "VpcId": "VPC_ID", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "Name": "Test Mongo SE", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "DatabaseName": "mytestdb", "EngineName": "mongodb", "ServerName": "test.example.com", "Port": "27017" } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeMongoRfc.json: Tasks for AWS DMS setup Version September 13, 2024 148 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeMongoRfc.json 4. Modify and save the CreateDmsSeMongoRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2hxcllf1b4ey0", "Title": "DMS_Source_MongoDB" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeMongoRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeMongoRfc.json --execution- parameters file://CreateDmsSeMongoParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use Mongo or any Relational Database Service (RDS) as a source endpoint. For an S3 source endpoint, see DMS source endpoint for S3: creating. DMS source endpoint for S3: creating Creating a DMS S3 Source Endpoint with the Console Screenshot of this change type in the AMS console: Tasks for AWS DMS setup Version September 13, 2024 149 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is
ams-appguide-050	ams-appguide.pdf	50	types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Tasks for AWS DMS setup Version September 13, 2024 150 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS S3 Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Tasks for AWS DMS setup Version September 13, 2024 151 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --title "S3DMSSourceEndpoint" -- aws-account-id ACCOUNT-ID --change-type-id ct-2oxl37nphsrjz --change-type-version 1.0 --execution-parameters "{\"Description\":\"TestS3DMS-SE\",\"VpcId\":\"VPC-ID\",\"Name \":\"S3-DMS-SE\",\"Parameters\":{\"EngineName\":\"s3\",\"S3BucketName\":\"amzn-s3- demo-bucket\",\"S3ExternalTableDefinition\":\"{\\\"TableCount\\\":\\\"1\\\",\\\"Tables \\\":[{\\\"TableName\\\":\\\"employee\\\",\\\"TablePath\\\":\\\"hr/employee/\\\",\\ \"TableOwner\\\":\\\"hr\\\",\\\"TableColumns\\\":[{\\\"ColumnName\\\":\\\"Id\\\",\\ \"ColumnType\\\":\\\"INT8\\\",\\\"ColumnNullable\\\":\\\"false\\\",\\\"ColumnIsPk\\\": \\\"true\\\"},{\\\"ColumnName\\\":\\\"LastName\\\",\\\"ColumnType\\\":\\\"STRING\\\", \\\"ColumnLength\\\":\\\"20\\\"},{\\\"ColumnName\\\":\\\"FirstName\\\",\\\"ColumnType \\\":\\\"STRING\\\",\\\"ColumnLength\\\":\\\"30\\\"},{\\\"ColumnName\\\":\\\"HireDate\ \\",\\\"ColumnType\\\":\\\"DATETIME\\\"},{\\\"ColumnName\\\":\\\"OfficeLocation\\\",\\ \"ColumnType\\\":\\\"STRING\\\",\\\"ColumnLength\\\":\\\"20\\\"}],\\\"TableColumnsTotal \\\":\\\"5\\\"}]}\",\"S3ServiceAccessRoleArn\":\"arn:aws:iam::123456789101:role/ams- ops-ct-authors-dms-s3-test-role\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm- pud4ghhkp7395n9bc\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeS3Params.json. aws amscm get-change-type-version --change-type-id "ct-2oxl37nphsrjz" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeS3Params.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "TestS3DMS-SE", "VpcId": "VPC_ID", "Name": "S3-DMS-SE", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "s3", "S3BucketName": "amzn-s3-demo-bucket", "S3ExternalTableDefinition": "BUCKET-NAME", Tasks for AWS DMS setup Version September 13, 2024 152 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options {"TableCount": "1", "Tables":[{"TableName":"employee","TablePath":"hr/ employee/","TableOwner":"hr","TableColumns": [{"ColumnName":"Id","ColumnType":"INT8","ColumnNullable":"false","ColumnIsPk":"true"}, {"ColumnName":"LastName","ColumnType":"STRING","ColumnLength":"20"}, {"ColumnName":"FirstName","ColumnType":"STRING","ColumnLength":"30"}, {"ColumnName":"HireDate","ColumnType":"DATETIME"}, {"ColumnName":"OfficeLocation","ColumnType":"STRING","ColumnLength":"20"}],"TableColumnsTotal":"5"}]}" "S3ServiceAccessRoleArn": "arn:aws:iam::123456789101:role/ams-ops-ct- authors-dms-s3-test-role", } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeS3Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeS3Rfc.json 4. Modify and save the CreateDmsSeS3Rfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2oxl37nphsrjz", "Title": "DMS_Source_S3" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeS3Rfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeS3Rfc.json --execution- parameters file://CreateDmsSeS3Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tasks for AWS DMS setup Version September 13, 2024 153 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use S3 or any Relational Database Service (RDS) source endpoint. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. 4: AWS DMS target endpoint: Create, create for S3 You can use the AMS console or API/CLI to create an AMS DMS target endpoint for various databases, we provide two
ams-appguide-051	ams-appguide.pdf	51	and does not start. Tasks for AWS DMS setup Version September 13, 2024 153 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use S3 or any Relational Database Service (RDS) source endpoint. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. 4: AWS DMS target endpoint: Create, create for S3 You can use the AMS console or API/CLI to create an AMS DMS target endpoint for various databases, we provide two examples. DMS target endpoint: creating AMS DMS can use S3 or any Relational Database Service (RDS) with MySQL, MariaDB, Oracle, Postgresql, or Microsoft SQL as a target endpoint. Creating a DMS Target Endpoint with the Console Screenshot of this change type in the AMS console: How it works: Tasks for AWS DMS setup Version September 13, 2024 154 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS Target Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Tasks for AWS DMS setup Version September 13, 2024 155 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3gf8dolbo8x9p" --change-type-version "1.0" --title "TestDMSTargetEndpoint" -- execution-parameters "{\"Description\":\"TestTE\",\"VpcId\":\"VPC-ID\",\"Name\": \"TE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u\",\"TimeoutInMinutes\":60, \"Parameters\":{\"EngineName\":\"mysql\",\"Password\":\"testpw123\",\"Port\":\"3306\", \"ServerName\":\"mytestdb.d5fga0rf2wpi.ap-southeast-2.rds.amazonaws.com\",\"Username\": \"USERNAME\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsTeParams.json. aws amscm get-change-type-version --change-type-id "ct-3gf8dolbo8x9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeParams.json Tasks for AWS DMS setup Version September 13, 2024 156 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "TestTE",
ams-appguide-052	ams-appguide.pdf	52	you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3gf8dolbo8x9p" --change-type-version "1.0" --title "TestDMSTargetEndpoint" -- execution-parameters "{\"Description\":\"TestTE\",\"VpcId\":\"VPC-ID\",\"Name\": \"TE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u\",\"TimeoutInMinutes\":60, \"Parameters\":{\"EngineName\":\"mysql\",\"Password\":\"testpw123\",\"Port\":\"3306\", \"ServerName\":\"mytestdb.d5fga0rf2wpi.ap-southeast-2.rds.amazonaws.com\",\"Username\": \"USERNAME\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsTeParams.json. aws amscm get-change-type-version --change-type-id "ct-3gf8dolbo8x9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeParams.json Tasks for AWS DMS setup Version September 13, 2024 156 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "TestTE", "VpcId": "VPC_ID", "StackTemplateId": "stm-knghtmmgefafdq89u", "Name": "TE-NAME", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "mysql", "ServerName": "sql.db.example.com", "Port": "3306", "Username": "DB-USER", "Password": "DB-PW",} } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsTeRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsTeRfc.json 4. Modify and save the CreateDmsTeRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3gf8dolbo8x9p", "Title": "DB-DMS-Target-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeRfc.json --execution- parameters file://CreateDmsTeParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tasks for AWS DMS setup Version September 13, 2024 157 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tips • This change type is now at version 2.0. • AMS DMS can use S3 or any Relational Database Service (RDS) with MySQL, MariaDB, Oracle, Postgresql, or Microsoft SQL as a target endpoint. For an S3 target endpoint, see DMS target endpoint for S3: creating. • For more information, see Targets for Data Migration. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. DMS target endpoint for S3: creating Creating a DMS S3 Target Endpoint with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Tasks for AWS DMS setup Version September 13, 2024 158 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a DMS S3 Target Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Tasks for AWS DMS setup Version September 13, 2024 159 AMS Advanced Application Developer's
ams-appguide-053	ams-appguide.pdf	53	Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Tasks for AWS DMS setup Version September 13, 2024 159 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-05muqzievnxk5" --change-type-version "1.0" --title "TestDMSTargetEndpointS3" --execution-parameters "{\"Description\":\"TestS3TE\",\"VpcId\":\"VPC-ID\",\"Name \":\"S3TE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u\",\"TimeoutInMinutes \":60,\"Parameters\":{\"EngineName\":\"s3\",\"S3BucketName\":\"amzn-s3-demo-bucket\", \"S3ServiceAccessRoleArn\":\"arn:aws:iam::123456789123:role/my-s3-role\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsTeS3Params.json: aws amscm get-change-type-version --change-type-id "ct-05muqzievnxk5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeS3Params.json 2. Modify and save the execution parameters CreateDmsTeS3Params.json ﬁle. For example, you can replace the contents with something like this: { "Description": "TestS3DMS-TE", "VpcId": "VPC_ID", "StackTemplateId": "stm-knghtmmgefafdq89u", "Name": "DMS-S3-TE", "TimeoutInMinutes": 60, Tasks for AWS DMS setup Version September 13, 2024 160 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Parameters": { "EngineName": "s3", "S3BucketName": "amzn-s3-demo-bucket", "S3ServiceAccessRoleArn": "arn:aws:iam::123456789101:role/ams-ops-ct- authors-dms-s3-test-role" } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsTeS3Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsTeS3Rfc.json 4. Modify and save the CreateDmsTeS3Rfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-05muqzievnxk5", "Title": "DMS_Target_S3" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeS3Rfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeS3Rfc.json --execution- parameters file://CreateDmsTeS3Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. Tasks for AWS DMS setup Version September 13, 2024 161 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS provides a separate change type for creating a target endpoint for S3. For more information, see Using Amazon S3 as a Target for AWS Database Migration Service and Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS. 5: AWS DMS replication task: Create You can use the AMS console or API/CLI to create an AMS AWS DMS replication task. Create AWS DMS replication task Creating a AWS DMS Replication Task with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Tasks for AWS DMS setup Version September 13, 2024 162 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC.
ams-appguide-054	ams-appguide.pdf	54	Version September 13, 2024 162 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a AWS DMS Replication Task with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status Tasks for AWS DMS setup Version September 13, 2024 163 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1d2fml15b9eth" --change-type-version "1.0" --title "TestDMSRepTask" -- execution-parameters "{\"Description\":\"TestRepTask\",\"VpcId\":\"VPC-ID\",\"Name \":\"DMSRepTask\",\"Parameters\":{\"CdcStartTime\":\1533776569\"MigrationType\": \"full-load\",\"ReplicationInstanceArn\":\"REP_INSTANCE_ARN\",\"SourceEndpointArn \":\"SOURCE_ENDPOINT_ARN\",\"TableMappings\":\"{\\\"rules\\\": [{\\\"rule-type \\\": \\\"selection\\\",\\\"rule-id\\\": \\\"1\\\",\\\"rule-name\\\": \\\"1\\ \",\\\"object-locator\\\": {\\\"schema-name\\\": \\\"Test\\\",\\\"table-name\\ \": \\\"%\\\"}, \\\"rule-action\\\": \\\"include\\\"}] }\",\"TargetEndpointArn \":\"TARGET_ENDPOINT_ARN\"},\"StackTemplateId\":\"stm-eos7uq0usnmeggdet\", \"TimeoutInMinutes\":60}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1d2fml15b9eth" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRtParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepTask", "VpcId": "VPC_ID", "StackTemplateId": "stm-eos7uq0usnmeggdet", "Name": "Test DMS RT", "TimeoutInMinutes": 60, Tasks for AWS DMS setup Version September 13, 2024 164 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Parameters": { "CdcStartTime": "1533776569", "MigrationType": "full-load", "ReplicationInstanceArn": "REP_INSTANCE_ARN", "SourceEndpointArn": "SOURCE_ENDPOINT_ARN", "TargetEndpointArn": "TARGET_ENDPOINT_ARN" "TableMappings": {"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"schema-name": "Test","table-name": "%"}, "rule-action": "include"}] }", } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRtRfc.json 4. Modify and save the CreateDmsRtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1d2fml15b9eth", "Title": "DMS-RI-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRtRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRtRfc.json --execution- parameters file://CreateDmsRtParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips You can create a AWS DMS task that captures three diﬀerent types of changes or data. For more information, see Working with AWS DMS Tasks, Creating a Task, and Creating Tasks for Ongoing Replication Using AWS DMS. Tasks for AWS DMS setup Version September 13, 2024 165 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AWS DMS management AWS DMS management examples. Start AWS DMS replication task Starting a AWS DMS replication task with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default
ams-appguide-055	ams-appguide.pdf	55	Creating Tasks for Ongoing Replication Using AWS DMS. Tasks for AWS DMS setup Version September 13, 2024 165 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AWS DMS management AWS DMS management examples. Start AWS DMS replication task Starting a AWS DMS replication task with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Managing your AWS DMS Version September 13, 2024 166 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Starting a AWS DMS replication task with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Managing your AWS DMS Version September 13, 2024 167 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1yq7hhqse71yg" --change-type-version "1.0" --title "Start DMS Replication Task" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StartDmsTask\",\"Region\":\"us-east-1\",\"Parameters\": {\"ReplicationTaskArn\":[\"TASK_ARN\"],\"StartReplicationTaskType\":[\"start- replication\"],\"CdcStartPosition\":[\"\"],\"CdcStopPosition\":[\"\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it StartDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1yq7hhqse71yg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StartDmsRtParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-StartDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": [ "TASK_ARN" ], "StartReplicationTaskType": [ "start-replication" ], "CdcStartPosition": [ "" ], "CdcStopPosition": [ "" ] } } Managing your AWS DMS Version September 13, 2024 168 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. Output the JSON template to a ﬁle in your current folder; this example names it StartDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > StartDmsRtRfc.json 4. Modify and save the StartDmsRtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1yq7hhqse71yg", "ChangeTypeVersion": "1.0", "Title": "Start DMS Replication Task" } 5. Create the RFC, specifying the execution parameters ﬁle and the StartDmsRtRfc ﬁle: aws amscm
ams-appguide-056	ams-appguide.pdf	56	"StartReplicationTaskType": [ "start-replication" ], "CdcStartPosition": [ "" ], "CdcStopPosition": [ "" ] } } Managing your AWS DMS Version September 13, 2024 168 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. Output the JSON template to a ﬁle in your current folder; this example names it StartDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > StartDmsRtRfc.json 4. Modify and save the StartDmsRtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1yq7hhqse71yg", "ChangeTypeVersion": "1.0", "Title": "Start DMS Replication Task" } 5. Create the RFC, specifying the execution parameters ﬁle and the StartDmsRtRfc ﬁle: aws amscm create-rfc --cli-input-json file://StartDmsRtRfc.json --execution- parameters file://StartDmsRtParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips You can start a AWS DMS replication task, using the AMS console or the AMS API/CLI. For more information, see Working with AWS DMS Tasks. Stop AWS DMS replication task Stopping a AWS DMS replication task with the Console Screenshot of this change type in the AMS console: Managing your AWS DMS Version September 13, 2024 169 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managing your AWS DMS Version September 13, 2024 170 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 5. Open the Run parameters area to see the conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Stopping a AWS DMS replication task with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managing your AWS DMS Version September 13, 2024 171 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --change-type-id "ct-1vd3y4ygbqmfk" --change-type-version "1.0" --title "Stop DMS Replication Task" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StopDmsTask\",\"Region\":\"us-east-1\",\"Parameters\": {\"ReplicationTaskArn\":[\"TASK_ARN\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type
ams-appguide-057	ams-appguide.pdf	57	the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managing your AWS DMS Version September 13, 2024 171 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --change-type-id "ct-1vd3y4ygbqmfk" --change-type-version "1.0" --title "Stop DMS Replication Task" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StopDmsTask\",\"Region\":\"us-east-1\",\"Parameters\": {\"ReplicationTaskArn\":[\"TASK_ARN\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it StopDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1vd3y4ygbqmfk" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StopDmsRtParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-StopDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": [ "TASK_ARN" ] } } 3. Output the JSON template to a ﬁle in your current folder; this example names it StopDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > StopDmsRtRfc.json 4. Modify and save the StopDmsRtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1vd3y4ygbqmfk", "ChangeTypeVersion": "1.0", "Title": "Stop DMS Replication Task" } 5. Create the RFC, specifying the execution parameters ﬁle and the StopDmsRtRfc ﬁle: Managing your AWS DMS Version September 13, 2024 172 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --cli-input-json file://StopDmsRtRfc.json --execution- parameters file://StopDmsRtParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips You can stop a DMS replication task, using the AMS console or the AMS API/CLI. For more information, see Working with AWS DMS Tasks. Database (DB) import to AMS RDS for Microsoft SQL Server Note The AMS API/CLI (amscm and amsskms) endpoints are in the AWS N. Virginia Region, us-east-1. Depending on how your authentication is set, and what AWS Region your account and resources are in, you may need to add --region us-east-1 when issuing commands. You may also need to add --profile saml, if that is your authentication method. The DB import to AMS RDS for SQL Server, process relies on AMS change types (CTs) submitted as requests for change (RFCs), and uses the Amazon RDS API parameters as input. MicroSoft SQL Server is a relational database management system (RDBMS). To learn more, see also: Amazon Relational Database Service (Amazon RDS) and rds or Amazon RDS API reference. Note Make sure each RFC completes successfully before moving on to the next step. High level import steps: 1. Back up your source on-premises MS SQL database into a .bak (backup) ﬁle 2. Copy the .bak ﬁle into the transit (encrypted) Amazon Simple Storage Service (S3) bucket Database (DB) import to AMS RDS for SQL Server Version September 13, 2024 173 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 3. Import the .bak into a new DB on your target Amazon RDS MS SQL instance Requirements: • MS SQL RDS stack in AMS • RDS stack with restore option (SQLSERVER_BACKUP_RESTORE) • Transit S3 bucket • IAM role with bucket access allowing Amazon RDS to assume the role • An EC2 instance with MS SQL Management Studio installed to manage the RDS (can be a workstation on-premises) Setting up Complete these tasks to begin the import process. 1. Submit an RFC to create an RDS stack using Deployment \| Advanced stack components \| RDS database stack \| Create (ct-2z60dyvto9g6c). Do not use the target DB name (RDSDBName parameter) in the creation request, the target DB will be created during the import. Make sure to allow enough space (RDSAllocatedStorage parameter). For details on doing this, see the AMS Change Management Guide RDS DB Stack \| Create. 2. Submit an RFC to create the transit S3 bucket (if does not exist already) using Deployment \| Advanced stack components \| S3 storage \| Create (ct-1a68ck03fn98r). For details on doing this, see the AMS Change Management Guide S3 Storage \| Create. 3. Submit a Management \| Other \| Other \| Update (ct-1e1xtak34nx76) RFC to implement the customer_rds_s3_role with these details: In the console: • Subject: "To support MS SQL Server Database Import, implement customer_rds_s3_role on this account. • Transit S3 bucket name: BUCKET_NAME. • Contact information: EMAIL. With an ImportDbParams.json ﬁle for the CLI: { "Comment": "{"Transit S3 bucket name":"BUCKET_NAME"}", Setting up Version September 13, 2024 174 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Priority": "High" } } 4. Submit a Management \| Other \| Other \| Update RFC requesting AMS to set the SQLSERVER_BACKUP_RESTORE option to the RDS created in step 1 (use the stack ID from
ams-appguide-058	ams-appguide.pdf	58	(ct-1e1xtak34nx76) RFC to implement the customer_rds_s3_role with these details: In the console: • Subject: "To support MS SQL Server Database Import, implement customer_rds_s3_role on this account. • Transit S3 bucket name: BUCKET_NAME. • Contact information: EMAIL. With an ImportDbParams.json ﬁle for the CLI: { "Comment": "{"Transit S3 bucket name":"BUCKET_NAME"}", Setting up Version September 13, 2024 174 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Priority": "High" } } 4. Submit a Management \| Other \| Other \| Update RFC requesting AMS to set the SQLSERVER_BACKUP_RESTORE option to the RDS created in step 1 (use the stack ID from the step 1 output, and the customer_rds_s3_role IAM role in this request, in this request). 5. Submit an RFC to create an EC2 instance (you can use any existing EC2 or on-premise workstation/instances), and install Microsoft SQL Management Studio on the instance. Importing the database To import the database (DB), follow these steps. 1. Back up your source on-premises database using MS SQL Native backup and restore (see Support for native backup and restore in SQL Server). As the result of running that operation, you should have a .bak (backup) ﬁle. 2. Upload the .bak ﬁle to and existing transit S3 bucket using the AWS S3 CLI or AWS S3 console. For information on transit S3 buckets, see Protecting data using encryption. 3. Import the .bak ﬁle into a new DB on your target RDS for SQL Server MS SQL instance (for details on types, see Amazon RDS for MySQL instance types): a. Log into the EC2 instance (on-premises workstation) and open MS SQL Management Studio b. Connect to the target RDS instance created as prerequisite in step #1. Follow this procedure to connect: Connecting to a DB Instance Running the Microsoft SQL Server Database Engine c. Start the import (restore) job with a new Structured Query Language (SQL) query (for details on SQL queries, see Introduction to SQL). The target database name must be new (do not use the same name as the database that you previously created). Example without encryption: exec msdb.dbo.rds_restore_database @restore_db_name=TARGET_DB_NAME, @s3_arn_to_restore_from='arn:aws:s3:::BUCKET_NAME/FILENAME.bak'; d. Periodically check the status of the import job by running this query in a separate window: Importing the database Version September 13, 2024 175 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options exec msdb.dbo.rds_task_status; If the status changes to Failed, look for the failure details in the message. Cleanup Once you have imported the database, you might want to remove unnecessary resources, follow these steps. 1. Delete the backup ﬁle (.bak) from the S3 bucket. You can use the S3 console to do this. For the CLI command to delete an object from an S3 bucket, see rm in the AWS CLI Command Reference. 2. Delete the S3 bucket if you’re not planning to use it. For steps on doing that, see Delete Stack. 3. If you’re not planning to do MS SQL imports, submit a Management \| Other \| Other \| Update (ct-0xdawir96cy7k) RFC and request that AMS delete the IAM role customer_rds_s3_role. Tier and Tie App Deployments in AMS A Tier and Tie deployment is where you create, conﬁgure, and deploy the resources of a stack independently using separate RFCs, and use the IDs of the stack components as you progress to associate them with each other. For example, to deploy a high availability (redundant) website behind a load balancer, and a database, using a Tier and Tie approach, submit RFCs for a database, and a load balancer, and two EC2 instances or an Auto Scaling group, and conﬁgure the EC2 instances or Auto Scaling group with the ID of the ELB that you created. After the resources deploy, you can submit a security group create change to allow the resources to talk to the database. For details about creating security groups, see Create Security Group. Full stack app deployments in AMS A Full Stack deployment is where you submit an RFC with a CT that creates and conﬁgures everything you need at once. For example, to deploy the high availability website just described (EC2 instances, load balancer, and database) you would use a CT that, all together, created and conﬁgured an Auto Scaling group, a load balancer, a database, and the security group settings Cleanup Version September 13, 2024 176 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options required for all instances to function as a stack. Examples of two AMS CTs that do this are described next. • High Availability Two-Tier Stack (ct-06mjngx5ﬂwto): This change type allows you to create a stack and conﬁgure an Auto Scaling Group, RDS-backed database, Load Balancer, and CodeDeploy application and conﬁguration. Note that the load balancer isn't considered a tier as it is shared across multiple applications as a network appliance and the CodeDeploy functions are also considered an
ams-appguide-059	ams-appguide.pdf	59	database, and the security group settings Cleanup Version September 13, 2024 176 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options required for all instances to function as a stack. Examples of two AMS CTs that do this are described next. • High Availability Two-Tier Stack (ct-06mjngx5ﬂwto): This change type allows you to create a stack and conﬁgure an Auto Scaling Group, RDS-backed database, Load Balancer, and CodeDeploy application and conﬁguration. Note that the load balancer isn't considered a tier as it is shared across multiple applications as a network appliance and the CodeDeploy functions are also considered an appliance. Additionally, it creates a CodeDeploy deployment group (with the name you give the CodeDeploy application) that can be used to deploy your applications. Security group settings to allow the resources to function together are automatically created. • High Availability One-Tier Stack (ct-09t6q7j9v5hrn): This change type allows you to create a stack and conﬁgure an Auto Scaling Group, and an Application Load Balancer. Security group settings that allow the resources to function together are automatically created. Working with provisioning change types (CTs) AMS has responsibility for your managed infrastructure, to make changes you must submit an RFC with the correct CT classiﬁcation (category, subcategory, item, and operation). This section describes how to ﬁnd CTs, determine if any are right for your needs, and request a new CT if none are. See if an existing CT meets your requirements Once you’ve determined what you want to deploy with AMS, the next step is to study the existing CTs and CloudFormation templates to see if a solution already exists. When creating an RFC, you must specify the CT. You can use the AWS Management Console or the AMS API/CLI. Examples of using both are described next. You can use the console or the API/CLI to ﬁnd a change type ID (CT) or version. There are two methods, either a search or choosing the classiﬁcation. For both selection types, You can sort the search by choosing either Most frequently used, Most recently used, or Alphabetical. YouTube Video: How do I create an RFC using the AWS Managed Services CLI and where can I ﬁnd the CT Schema? In the AMS console, on the RFCs -> Create RFC page: • With Browse by change type selected (the default), either: Working with provisioning change types (CTs) Version September 13, 2024 177 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Use the Quick create area to select from AMS's most popular CTs. Click on a label and the Run RFC page opens with the Subject option auto-ﬁlled for you. Complete the remaining options as needed and click Run to submit the RFC. • Or, scroll down to the All change types area and start typing a CT name in the option box, you don't have to have the exact or full change type name. You can also search for a CT by change type ID, classiﬁcation, or execution mode (automated or manual) by entering the relevant words. With the default Cards view selected, matching CT cards appear as you type, select a card and click Create RFC. With the Table view selected, choose the relevant CT and click Create RFC. Both methods open the Run RFC page. • Alternatively, and to explore change type choices, click Choose by category at the top of the page to open a series of drop-down option boxes. • Choose Category, a Subcategory, an Item, and an Operation. The information box for that change type appears a panel appears at the bottom of the page. • When you're ready, press Enter, and a list of matching change types appears. • Choose a change type from the list. The information box for that change type appears at the bottom of the page. • After you have the correct change type, choose Create RFC. Note The AMS CLI must be installed for these commands to work. To install the AMS API or CLI, go to the AMS console Developers Resources page. For reference material on the AMS CM API or AMS SKMS API, see the AMS Information Resources section in the User Guide. You may need to add a --profile option for authentication; for example, aws amsskms ams-cli-command --profile SAML. You may also need to add the --region option as all AMS commands run out of us-east-1; for example aws amscm ams-cli-command -- region=us-east-1. Note The AMS API/CLI (amscm and amsskms) endpoints are in the AWS N. Virginia Region, us-east-1. Depending on how your authentication is set, and what AWS Region your See if an existing CT meets your requirements Version September 13, 2024 178 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options account and resources are in, you may need to add --region us-east-1 when issuing commands.
ams-appguide-060	ams-appguide.pdf	60	option for authentication; for example, aws amsskms ams-cli-command --profile SAML. You may also need to add the --region option as all AMS commands run out of us-east-1; for example aws amscm ams-cli-command -- region=us-east-1. Note The AMS API/CLI (amscm and amsskms) endpoints are in the AWS N. Virginia Region, us-east-1. Depending on how your authentication is set, and what AWS Region your See if an existing CT meets your requirements Version September 13, 2024 178 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options account and resources are in, you may need to add --region us-east-1 when issuing commands. You may also need to add --profile saml, if that is your authentication method. To search for a change type using the AMS CM API (see ListChangeTypeClassiﬁcationSummaries) or CLI: You can use a ﬁlter or query to search. The ListChangeTypeClassiﬁcationSummaries operation has Filters options for Category, Subcategory, Item, and Operation, but the values must match the existing values exactly. For more ﬂexible results when using the CLI, you can use the --query option. Change type ﬁltering with the AMS CM API/CLI Attribute Valid values ChangeTypeId Any string represent ing a ChangeTypeId (For ex: ct-abc123 xyz7890) Valid/Default condition Equals Category Any free-form text Contains Subcategory Item Operation 1. Here are some examples of listing change type classiﬁcations: The following command lists all change type categories. aws amscm list-change-type-categories Notes For change type IDs, see the Change Type Reference. For change type IDs, see Finding a Change Type or CSIO. Regular expressio ns in each individua l ﬁeld are not supported. Case insensitive search See if an existing CT meets your requirements Version September 13, 2024 179 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options The following command lists the subcategories belonging to a speciﬁed category. aws amscm list-change-type-subcategories --category CATEGORY The following command lists the items belonging to a speciﬁed category and subcategory. aws amscm list-change-type-items --category CATEGORY --subcategory SUBCATEGORY 2. Here are some examples of searching for change types with CLI queries: The following command searches CT classiﬁcation summaries for those that contain "S3" in the Item name and creates output of the category, subcategory, item, operation, and change type ID in table form. aws amscm list-change-type-classification-summaries --query "ChangeTypeClassificationSummaries [?contains(Item, 'S3')]. [Category,Subcategory,Item,Operation,ChangeTypeId]" --output table +---------------------------------------------------------------+ \| ListChangeTypeClassificationSummaries \| +----------+-------------------------+--+------+----------------+ \|Deployment\|Advanced Stack Components\|S3\|Create\|ct-1a68ck03fn98r\| +----------+-------------------------+--+------+----------------+ 3. You can then use the change type ID to get the CT schema and examine the parameters. The following command outputs the schema to a JSON ﬁle named CreateS3Params.schema.json. aws amscm get-change-type-version --change-type-id "ct-1a68ck03fn98r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateS3Params.schema.json For information about using CLI queries, see How to Filter the Output with the --query Option and the query language reference, JMESPath Speciﬁcation. 4. After you have the change type ID, we recommend verifying the version for the change type to make sure it's the latest version. Use this command to ﬁnd the version for a speciﬁed change type: See if an existing CT meets your requirements Version September 13, 2024 180 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CHANGE_TYPE_ID To ﬁnd the AutomationStatus for a speciﬁc change type, run this command: aws amscm --profile saml get-change-type-version --change-type-id CHANGE_TYPE_ID -- query "ChangeTypeVersion.{AutomationStatus:AutomationStatus.Name}" To ﬁnd the ExpectedExecutionDurationInMinutes for a speciﬁc change type, run this command: aws amscm --profile saml get-change-type-version --change-type-id ct-14027q0sjyt1h --query "ChangeTypeVersion.{ExpectedDuration:ExpectedExecutionDurationInMinutes}" Once you have found a CT that you think is appropriate, look at the execution parameters JSON schema associated with it to learn if it addresses your use case. Use this command to output a CT schema to a JSON ﬁle named after the CT; this example outputs the Create S3 storage schema: aws amscm get-change-type-version --change-type-id "ct-1a68ck03fn98r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateBucketParams.json Let’s take a close look at what this schema oﬀers. S3 Bucket Create Schema { "$schema": "http://json-schema.org/draft-04/sch ema#", "name": "Create S3 Storage "description": "Use to create an Amazon Simple Storage Service stack.", "type": "object", "properties": { "Description": { "description": "The description of the stack.", The schema begins with the CT ("description"), which tells you what the schema is for. In this case, to create an S3 storage stack. Next, you have required and optional properties that you can specify. Default property values are given. The See if an existing CT meets your requirements Version September 13, 2024 181 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "type": "string", "minLength": 1, "maxLength": 500 }, "VpcId": { "description": "ID of the VPC to create the S3 Bucket in, in the form vpc-a1b2c3d4e5f67890e.", "type": "string", "pattern": "^vpc-[a-z0-9]{17}$" }, "StackTemplateId": { "description": "Required value: stm-s2b72 beb000000000.", "type": "string", "enum": ["stm-s2b72beb000000000"] }, "Name":{ "description": "The name of the stack to create.", "type": "string", "minLength": 1, "maxLength": 255 }, "Tags": { "description": "Up to seven tags (key/value properties that are required are listed at
ams-appguide-061	ams-appguide.pdf	61	property values are given. The See if an existing CT meets your requirements Version September 13, 2024 181 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "type": "string", "minLength": 1, "maxLength": 500 }, "VpcId": { "description": "ID of the VPC to create the S3 Bucket in, in the form vpc-a1b2c3d4e5f67890e.", "type": "string", "pattern": "^vpc-[a-z0-9]{17}$" }, "StackTemplateId": { "description": "Required value: stm-s2b72 beb000000000.", "type": "string", "enum": ["stm-s2b72beb000000000"] }, "Name":{ "description": "The name of the stack to create.", "type": "string", "minLength": 1, "maxLength": 255 }, "Tags": { "description": "Up to seven tags (key/value properties that are required are listed at the end of the schema. In the StackTemplateId area, you see that there is one speciﬁc stack template for this CT and schema, and its ID is a required property value. The schema allows you to tag the stack you are creating, for internal bookkeeping purposes. Additionally, some options, like backup, require a tag of Key:backup and Value:true. For in-depth information, read Tagging Your Amazon EC2 Resources. pairs) for the stack.", "type": "array", "items": { "type": "object", "properties": { "Key": { "type": "string", "minLength": 1, "maxLength": 127 }, "Value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false, "required": [ "Key", See if an existing CT meets your requirements Version September 13, 2024 182 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Value" ] }, "minItems": 1, "maxItems": 7 }, "TimeoutInMinutes": { "description": "The amount of time, in minutes, to allow for creation of the stack.", "type": "number", "minimum": 0, "maximum": 60 }, "Parameters": { "description": "Specifications for the stack.", "type": "object", "properties": { "AccessControl": { "description": "The canned (predefined) access control list (ACL) to assign to the bucket.", "type": "string", "enum": [ "Private", "PublicRead", "AuthenticatedRead", "BucketOwnerRead" ] }, "BucketName": { "description": "A name for the bucket. The bucket name must contain only lowercase letters, numbers, periods (.), and hyphens (-).", "type": "string", "pattern": "^[a-z0-9]([-.a-z0-9]+)[a-z 0-9]$", "minLength": 3, "maxLength": 63 } }, "additionalProperties": false, "required": [ "AccessControl", "BucketName" The Parameters section of the CT JSON schema is where you provide the execution parameters. For this schema, only the ACL and BucketName are required execution parameters. See if an existing CT meets your requirements Version September 13, 2024 183 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options ] } }, "additionalProperties": false, "required": [ "Description", "VpcId", "StackTemplateId", "Name", "TimeoutInMinutes", "Parameters" ] } Request a new CT After examining the schema, you may decide that it does not provide enough parameters to create the deployment that you want. If that is the case, examine existing CloudFormation templates to ﬁnd one that is closer to what you want. Once you know what additional parameters you need, submit a Management \| Other \| Other \| Create CT. Note All Other \| Other Create and Update CTs receive the attention of an AMS operator, who will contact you to discuss the new CT. To submit a request for a new CT, access the AMS console through the regular AWS Management Console and then follow these steps. 1. From the left navigation, click RFCs. The RFCs dashboard page opens. 2. Click Create. The Create a request for change page opens. 3. Select Management in the Category drop-down list, and Other for the Subcategory and Item. For the Operation, choose Create. The RFC will need approval before it can be implemented. Request a new CT Version September 13, 2024 184 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. Enter information for why you want the CT, for example: Requesting a modiﬁed Create S3 storage CT that allows custom ACLs, based on the existing Create S3 storage CT. This should result in a new CT: Deployment \| Advanced Stack Components \| S3 storage \| Create S3 custom ACL. This new CT could be public. 5. Click Submit. Your RFC displays on the RFC dashboard. Test the new CT Once AWS Managed Services has created that new CT, you test it by submitting an RFC with it. If you worked with AMS to make the new CT pre-approved, then you can simply follow a standard RFC submission, and watch for the result (for details on submitting RFCs, see Creating and Submitting an RFC). If the new CT is not pre-approved (you want to be sure that it is never run without explicit approval), then you will need to discuss its implementation with AMS each time you want to run it. Test the new CT Version September 13, 2024 185 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Quick starts Topics • AMS Resource Scheduler quick start • Setting up cross account backups (intra-Region) Using a combination of AMS change types, you can accomplish complex tasks. You can use the AMS change management system to set up AMS Resource

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.