AWS.Tools.Amplify.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Amplify</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AMP.AddAMPResourceTagCmdlet"> <summary> Tags the resource with a tag key and value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.AddAMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) to use to tag a resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.AddAMPResourceTagCmdlet.Tag"> <summary> <para> <para>The tags used to tag the resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.AddAMPResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.AddAMPResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppCmdlet"> <summary> Returns an existing Amplify app specified by an app ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'App'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetAppResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppListCmdlet"> <summary> Returns a list of the existing Amplify apps.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppListCmdlet.NextToken"> <summary> <para> <para>A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Apps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListAppsResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListAppsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPAppListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet"> <summary> Returns a list of artifacts for a specified app, branch, and job.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.BranchName"> <summary> <para> <para>The name of a branch that is part of an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.JobId"> <summary> <para> <para>The unique ID for a job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.NextToken"> <summary> <para> <para>A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Artifacts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListArtifactsResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListArtifactsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactUrlCmdlet"> <summary> Returns the artifact info that corresponds to an artifact id. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactUrlCmdlet.ArtifactId"> <summary> <para> <para>The unique ID for an artifact. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPArtifactUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetArtifactUrlResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetArtifactUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentCmdlet"> <summary> Returns a backend environment for an Amplify app. <para> This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentCmdlet.AppId"> <summary> <para> <para>The unique id for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>The name for the backend environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackendEnvironment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetBackendEnvironmentResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetBackendEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet"> <summary> Lists the backend environments for an Amplify app. <para> This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.EnvironmentName"> <summary> <para> <para>The name of the backend environment </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.NextToken"> <summary> <para> <para>A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackendEnvironments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListBackendEnvironmentsResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListBackendEnvironmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBackendEnvironmentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchCmdlet"> <summary> Returns a branch for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchCmdlet.BranchName"> <summary> <para> <para>The name of the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Branch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetBranchResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetBranchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet"> <summary> Lists the branches of an Amplify app.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet.NextToken"> <summary> <para> <para>A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Branches'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListBranchesResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListBranchesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPBranchListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationCmdlet"> <summary> Returns the domain information for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationCmdlet.AppId"> <summary> <para> <para> The unique id for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationCmdlet.DomainName"> <summary> <para> <para> The name of the domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetDomainAssociationResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetDomainAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet"> <summary> Returns the domain associations for an Amplify app.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet.NextToken"> <summary> <para> <para> A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainAssociations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListDomainAssociationsResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListDomainAssociationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPDomainAssociationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobCmdlet"> <summary> Returns a job for a branch of an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobCmdlet.JobId"> <summary> <para> <para>The unique ID for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Job'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetJobResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet"> <summary> Lists the jobs for a branch of an Amplify app.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.NextToken"> <summary> <para> <para>A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListJobsResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPResourceTagCmdlet"> <summary> Returns a list of tags for a specified Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) to use to list tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookCmdlet"> <summary> Returns the webhook information that corresponds to a specified webhook ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookCmdlet.WebhookId"> <summary> <para> <para>The unique ID for a webhook. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GetWebhookResponse). Specifying the name of a property of type Amazon.Amplify.Model.GetWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet"> <summary> Returns a list of webhooks for an Amplify app.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of records to list in a single response. </para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet.NextToken"> <summary> <para> <para>A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Webhooks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.ListWebhooksResponse). Specifying the name of a property of type Amazon.Amplify.Model.ListWebhooksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.GetAMPWebhookListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet"> <summary> Returns the website access logs for a specific time range using a presigned URL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.DomainName"> <summary> <para> <para>The name of the domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.EndTime"> <summary> <para> <para>The time at which the logs should end. The time range specified is inclusive of the end time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.StartTime"> <summary> <para> <para>The time at which the logs should start. The time range specified is inclusive of the start time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LogUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.GenerateAccessLogsResponse). Specifying the name of a property of type Amazon.Amplify.Model.GenerateAccessLogsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAccessLogCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet"> <summary> Creates a new Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AccessToken"> <summary> <para> <para>The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.</para><para>Use <c>accessToken</c> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <c>oauthToken</c>.</para><para>You must specify either <c>accessToken</c> or <c>oauthToken</c> when you create a new app.</para><para>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationPattern"> <summary> <para> <para>The automated branch creation glob patterns for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_BasicAuthCredential"> <summary> <para> <para>The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.BasicAuthCredential"> <summary> <para> <para>The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_BuildSpec"> <summary> <para> <para>The build specification (build spec) for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.BuildSpec"> <summary> <para> <para>The build specification (build spec) for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.CustomHeader"> <summary> <para> <para>The custom HTTP headers for an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.CustomRule"> <summary> <para> <para>The custom rewrite and redirect rules for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Description"> <summary> <para> <para>The description of the Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.EnableAutoBranchCreation"> <summary> <para> <para>Enables automated branch creation for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_EnableAutoBuild"> <summary> <para> <para>Enables auto building for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_EnableBasicAuth"> <summary> <para> <para>Enables basic authorization for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.EnableBasicAuth"> <summary> <para> <para>Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.EnableBranchAutoBuild"> <summary> <para> <para>Enables the auto building of branches for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.EnableBranchAutoDeletion"> <summary> <para> <para>Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_EnablePerformanceMode"> <summary> <para> <para>Enables performance mode for the branch.</para><para>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_EnablePullRequestPreview"> <summary> <para> <para>Enables pull request previews for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_EnvironmentVariable"> <summary> <para> <para>The environment variables for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.EnvironmentVariable"> <summary> <para> <para>The environment variables map for an Amplify app. </para><para>For a list of the environment variables that are accessible to Amplify by default, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify Environment variables</a> in the <i>Amplify Hosting User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_Framework"> <summary> <para> <para>The framework for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.IamServiceRoleArn"> <summary> <para> <para>The AWS Identity and Access Management (IAM) service role for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Name"> <summary> <para> <para>The name of the Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.OauthToken"> <summary> <para> <para>The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.</para><para>Use <c>oauthToken</c> for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use <c>accessToken</c>.</para><para>You must specify either <c>oauthToken</c> or <c>accessToken</c> when you create a new app.</para><para>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Platform"> <summary> <para> <para>The platform for the Amplify app. For a static app, set the platform type to <c>WEB</c>. For a dynamic server-side rendered (SSR) app, set the platform type to <c>WEB_COMPUTE</c>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <c>WEB_DYNAMIC</c>.</para><para>If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to <c>WEB_COMPUTE</c> and set the artifacts <c>baseDirectory</c> to <c>.next</c> in the application's build settings. For an example of the build specification settings, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14">Amplify build settings for a Next.js 14 SSG application</a> in the <i>Amplify Hosting User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_PullRequestEnvironmentName"> <summary> <para> <para>The Amplify environment name for the pull request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Repository"> <summary> <para> <para>The Git repository for the Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.AutoBranchCreationConfig_Stage"> <summary> <para> <para>Describes the current stage for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Tag"> <summary> <para> <para>The tag for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.CacheConfig_Type"> <summary> <para> <para>The type of cache configuration to use for an Amplify app.</para><para>The <c>AMPLIFY_MANAGED</c> cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.</para><para>The <c>AMPLIFY_MANAGED_NO_COOKIES</c> cache configuration type is the same as <c>AMPLIFY_MANAGED</c>, except that it excludes all cookies from the cache key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'App'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateAppResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPAppCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet"> <summary> Creates a new backend environment for an Amplify app. <para> This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.DeploymentArtifact"> <summary> <para> <para>The name of deployment artifacts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>The name for the backend environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.StackName"> <summary> <para> <para>The AWS CloudFormation stack name of a backend environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackendEnvironment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateBackendEnvironmentResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateBackendEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBackendEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet"> <summary> Creates a new branch for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.BackendEnvironmentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. </para><para>This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.BasicAuthCredential"> <summary> <para> <para> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.BranchName"> <summary> <para> <para>The name for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.BuildSpec"> <summary> <para> <para> The build specification (build spec) for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Description"> <summary> <para> <para>The description for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.DisplayName"> <summary> <para> <para> The display name for a branch. This is used as the default domain prefix. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnableAutoBuild"> <summary> <para> <para> Enables auto building for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnableBasicAuth"> <summary> <para> <para> Enables basic authorization for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnableNotification"> <summary> <para> <para> Enables notifications for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnablePerformanceMode"> <summary> <para> <para>Enables performance mode for the branch.</para><para>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnablePullRequestPreview"> <summary> <para> <para> Enables pull request previews for this branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.EnvironmentVariable"> <summary> <para> <para> The environment variables for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Framework"> <summary> <para> <para> The framework for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.PullRequestEnvironmentName"> <summary> <para> <para> The Amplify environment name for the pull request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Backend_StackArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the CloudFormation stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Stage"> <summary> <para> <para>Describes the current stage for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Tag"> <summary> <para> <para> The tag for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Ttl"> <summary> <para> <para> The content Time To Live (TTL) for the website in seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Branch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateBranchResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateBranchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPBranchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet"> <summary> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. <para> The maximum duration between the <c>CreateDeployment</c> call and the <c>StartDeployment</c> call cannot exceed 8 hours. If the duration exceeds 8 hours, the <c>StartDeployment</c> call and the associated <c>Job</c> will fail. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet.BranchName"> <summary> <para> <para> The name of the branch to use for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet.FileMap"> <summary> <para> <para> An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateDeploymentResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet"> <summary> Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.AutoSubDomainCreationPattern"> <summary> <para> <para> Sets the branch patterns for automatic subdomain creation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.AutoSubDomainIAMRole"> <summary> <para> <para> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.CertificateSettings_CustomCertificateArn"> <summary> <para> <para>The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.</para><para>This field is required only when the certificate type is <c>CUSTOM</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.DomainName"> <summary> <para> <para> The domain name for the domain association. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.EnableAutoSubDomain"> <summary> <para> <para> Enables the automated creation of subdomains for branches. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.SubDomainSetting"> <summary> <para> <para> The setting for the subdomain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.CertificateSettings_Type"> <summary> <para> <para>The certificate type.</para><para>Specify <c>AMPLIFY_MANAGED</c> to use the default certificate that Amplify provisions for you.</para><para>Specify <c>CUSTOM</c> to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into Certificate Manager</a> in the <i>ACM User guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateDomainAssociationResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateDomainAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPDomainAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet"> <summary> Creates a new webhook on an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet.BranchName"> <summary> <para> <para>The name for a branch that is part of an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet.Description"> <summary> <para> <para>The description for a webhook. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.CreateWebhookResponse). Specifying the name of a property of type Amazon.Amplify.Model.CreateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.NewAMPWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPAppCmdlet"> <summary> Deletes an existing Amplify app specified by an app ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPAppCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'App'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteAppResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPAppCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBackendEnvironmentCmdlet"> <summary> Deletes a backend environment for an Amplify app. <para> This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBackendEnvironmentCmdlet.AppId"> <summary> <para> <para>The unique ID of an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBackendEnvironmentCmdlet.EnvironmentName"> <summary> <para> <para>The name of a backend environment of an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBackendEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BackendEnvironment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteBackendEnvironmentResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteBackendEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBackendEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBranchCmdlet"> <summary> Deletes a branch for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBranchCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBranchCmdlet.BranchName"> <summary> <para> <para>The name of the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBranchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Branch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteBranchResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteBranchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPBranchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPDomainAssociationCmdlet"> <summary> Deletes a domain association for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPDomainAssociationCmdlet.AppId"> <summary> <para> <para> The unique id for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPDomainAssociationCmdlet.DomainName"> <summary> <para> <para> The name of the domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPDomainAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteDomainAssociationResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteDomainAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPDomainAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet"> <summary> Deletes a job for a branch of an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet.JobId"> <summary> <para> <para> The unique ID for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteJobResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPResourceTagCmdlet"> <summary> Untags a resource with a specified Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) to use to untag a resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to use to untag a resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPWebhookCmdlet"> <summary> Deletes a webhook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPWebhookCmdlet.WebhookId"> <summary> <para> <para>The unique ID for a webhook. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPWebhookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.DeleteWebhookResponse). Specifying the name of a property of type Amazon.Amplify.Model.DeleteWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.RemoveAMPWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet"> <summary> Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. <para> The maximum duration between the <c>CreateDeployment</c> call and the <c>StartDeployment</c> call cannot exceed 8 hours. If the duration exceeds 8 hours, the <c>StartDeployment</c> call and the associated <c>Job</c> will fail. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.JobId"> <summary> <para> <para>The job ID for this deployment, generated by the create deployment request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.SourceUrl"> <summary> <para> <para>The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.StartDeploymentResponse). Specifying the name of a property of type Amazon.Amplify.Model.StartDeploymentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPDeploymentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet"> <summary> Starts a new job for a branch of an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.CommitId"> <summary> <para> <para> The commit ID from a third-party repository provider for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.CommitMessage"> <summary> <para> <para> The commit message from a third-party repository provider for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.CommitTime"> <summary> <para> <para> The commit date and time for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.JobId"> <summary> <para> <para>The unique ID for an existing job. This is required if the value of <c>jobType</c> is <c>RETRY</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.JobReason"> <summary> <para> <para>A descriptive reason for starting the job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.JobType"> <summary> <para> <para>Describes the type for the job. The job type <c>RELEASE</c> starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. </para><para>The job type <c>RETRY</c> retries an existing job. If the job type value is <c>RETRY</c>, the <c>jobId</c> is also required. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.StartJobResponse). Specifying the name of a property of type Amazon.Amplify.Model.StartJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StartAMPJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet"> <summary> Stops a job that is in progress for a branch of an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet.BranchName"> <summary> <para> <para>The name of the branch to use for the stop job request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet.JobId"> <summary> <para> <para> The unique id for the job. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.StopJobResponse). Specifying the name of a property of type Amazon.Amplify.Model.StopJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.StopAMPJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet"> <summary> Updates an existing Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AccessToken"> <summary> <para> <para>The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.</para><para>Use <c>accessToken</c> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <c>oauthToken</c>.</para><para>You must specify either <c>accessToken</c> or <c>oauthToken</c> when you update an app.</para><para>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AppId"> <summary> <para> <para>The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationPattern"> <summary> <para> <para>Describes the automated branch creation glob patterns for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_BasicAuthCredential"> <summary> <para> <para>The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.BasicAuthCredential"> <summary> <para> <para>The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_BuildSpec"> <summary> <para> <para>The build specification (build spec) for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.BuildSpec"> <summary> <para> <para>The build specification (build spec) for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.CustomHeader"> <summary> <para> <para>The custom HTTP headers for an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.CustomRule"> <summary> <para> <para>The custom redirect and rewrite rules for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Description"> <summary> <para> <para>The description for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.EnableAutoBranchCreation"> <summary> <para> <para>Enables automated branch creation for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_EnableAutoBuild"> <summary> <para> <para>Enables auto building for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_EnableBasicAuth"> <summary> <para> <para>Enables basic authorization for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.EnableBasicAuth"> <summary> <para> <para>Enables basic authorization for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.EnableBranchAutoBuild"> <summary> <para> <para>Enables branch auto-building for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.EnableBranchAutoDeletion"> <summary> <para> <para>Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_EnablePerformanceMode"> <summary> <para> <para>Enables performance mode for the branch.</para><para>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_EnablePullRequestPreview"> <summary> <para> <para>Enables pull request previews for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_EnvironmentVariable"> <summary> <para> <para>The environment variables for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.EnvironmentVariable"> <summary> <para> <para>The environment variables for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_Framework"> <summary> <para> <para>The framework for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.IamServiceRoleArn"> <summary> <para> <para>The AWS Identity and Access Management (IAM) service role for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Name"> <summary> <para> <para>The name for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.OauthToken"> <summary> <para> <para>The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.</para><para>Use <c>oauthToken</c> for repository providers other than GitHub, such as Bitbucket or CodeCommit.</para><para>To authorize access to GitHub as your repository provider, use <c>accessToken</c>.</para><para>You must specify either <c>oauthToken</c> or <c>accessToken</c> when you update an app.</para><para>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Platform"> <summary> <para> <para>The platform for the Amplify app. For a static app, set the platform type to <c>WEB</c>. For a dynamic server-side rendered (SSR) app, set the platform type to <c>WEB_COMPUTE</c>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <c>WEB_DYNAMIC</c>.</para><para>If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to <c>WEB_COMPUTE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_PullRequestEnvironmentName"> <summary> <para> <para>The Amplify environment name for the pull request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Repository"> <summary> <para> <para>The name of the Git repository for an Amplify app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.AutoBranchCreationConfig_Stage"> <summary> <para> <para>Describes the current stage for the autocreated branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.CacheConfig_Type"> <summary> <para> <para>The type of cache configuration to use for an Amplify app.</para><para>The <c>AMPLIFY_MANAGED</c> cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.</para><para>The <c>AMPLIFY_MANAGED_NO_COOKIES</c> cache configuration type is the same as <c>AMPLIFY_MANAGED</c>, except that it excludes all cookies from the cache key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'App'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UpdateAppResponse). Specifying the name of a property of type Amazon.Amplify.Model.UpdateAppResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPAppCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet"> <summary> Updates a branch for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.BackendEnvironmentArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. </para><para>This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.BasicAuthCredential"> <summary> <para> <para> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <c>user:password</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.BranchName"> <summary> <para> <para>The name of the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.BuildSpec"> <summary> <para> <para> The build specification (build spec) for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Description"> <summary> <para> <para> The description for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.DisplayName"> <summary> <para> <para> The display name for a branch. This is used as the default domain prefix. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnableAutoBuild"> <summary> <para> <para> Enables auto building for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnableBasicAuth"> <summary> <para> <para> Enables basic authorization for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnableNotification"> <summary> <para> <para> Enables notifications for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnablePerformanceMode"> <summary> <para> <para>Enables performance mode for the branch.</para><para>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnablePullRequestPreview"> <summary> <para> <para> Enables pull request previews for this branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.EnvironmentVariable"> <summary> <para> <para> The environment variables for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Framework"> <summary> <para> <para> The framework for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.PullRequestEnvironmentName"> <summary> <para> <para> The Amplify environment name for the pull request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Backend_StackArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the CloudFormation stack.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Stage"> <summary> <para> <para> Describes the current stage for the branch. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Ttl"> <summary> <para> <para> The content Time to Live (TTL) for the website in seconds. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Branch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UpdateBranchResponse). Specifying the name of a property of type Amazon.Amplify.Model.UpdateBranchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPBranchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet"> <summary> Creates a new domain association for an Amplify app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.AppId"> <summary> <para> <para> The unique ID for an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.AutoSubDomainCreationPattern"> <summary> <para> <para> Sets the branch patterns for automatic subdomain creation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.AutoSubDomainIAMRole"> <summary> <para> <para> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.CertificateSettings_CustomCertificateArn"> <summary> <para> <para>The Amazon resource name (ARN) for the custom certificate that you have already added to Certificate Manager in your Amazon Web Services account.</para><para>This field is required only when the certificate type is <c>CUSTOM</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.DomainName"> <summary> <para> <para> The name of the domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.EnableAutoSubDomain"> <summary> <para> <para> Enables the automated creation of subdomains for branches. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.SubDomainSetting"> <summary> <para> <para> Describes the settings for the subdomain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.CertificateSettings_Type"> <summary> <para> <para>The certificate type.</para><para>Specify <c>AMPLIFY_MANAGED</c> to use the default certificate that Amplify provisions for you.</para><para>Specify <c>CUSTOM</c> to use your own certificate that you have already added to Certificate Manager in your Amazon Web Services account. Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into Certificate Manager</a> in the <i>ACM User guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainAssociation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UpdateDomainAssociationResponse). Specifying the name of a property of type Amazon.Amplify.Model.UpdateDomainAssociationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPDomainAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet"> <summary> Updates a webhook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet.BranchName"> <summary> <para> <para>The name for a branch that is part of an Amplify app. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet.Description"> <summary> <para> <para>The description for a webhook. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet.WebhookId"> <summary> <para> <para>The unique ID for a webhook. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Amplify.Model.UpdateWebhookResponse). Specifying the name of a property of type Amazon.Amplify.Model.UpdateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AMP.UpdateAMPWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |