AWS.Tools.AppRunner.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AppRunner</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet"> <summary> Associate your own domain name with the App Runner subdomain URL of your App Runner service. <para> After you call <code>AssociateCustomDomain</code> and receive a successful response, use the information in the <a>CustomDomain</a> record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner tracks domain validity in a certificate stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide">AWS Certificate Manager (ACM)</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet.DomainName"> <summary> <para> <para>A custom domain endpoint to associate. Specify a root domain (for example, <code>example.com</code>), a subdomain (for example, <code>login.example.com</code> or <code>admin.login.example.com</code>), or a wildcard (for example, <code>*.example.com</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet.EnableWWWSubdomain"> <summary> <para> <para>Set to <code>true</code> to associate the subdomain <code>www.<i>DomainName</i></code> with the App Runner service in addition to the base domain.</para><para>Default: <code>true</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet.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.AppRunner.Model.AssociateCustomDomainResponse). Specifying the name of a property of type Amazon.AppRunner.Model.AssociateCustomDomainResponse 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.AAR.AddAARCustomDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARCustomDomainCmdlet.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.AAR.AddAARResourceTagCmdlet"> <summary> Add tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to update tags for.</para><para>It must be the ARN of an App Runner resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARResourceTagCmdlet.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.AppRunner.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.AddAARResourceTagCmdlet.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.AAR.GetAARAutoScalingConfigurationCmdlet"> <summary> Return a full description of an App Runner automatic scaling configuration resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationCmdlet.AutoScalingConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.</para><para>The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either <code>.../<i>name</i></code> or <code>.../<i>name</i>/<i>revision</i></code>. If a revision isn't specified, the latest active revision is described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoScalingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.DescribeAutoScalingConfigurationResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DescribeAutoScalingConfigurationResponse 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.AAR.GetAARAutoScalingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoScalingConfigurationArn parameter. The -PassThru parameter is deprecated, use -Select '^AutoScalingConfigurationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationListCmdlet"> <summary> Returns a list of App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all configurations in your account. You can optionally query only the latest revision of each requested name.<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.AAR.GetAARAutoScalingConfigurationListCmdlet.AutoScalingConfigurationName"> <summary> <para> <para>The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationListCmdlet.LatestOnly"> <summary> <para> <para>Set to <code>true</code> to list only the latest revision for each requested configuration name.</para><para>Keep as <code>false</code> to list all revisions for each requested configuration name.</para><para>Default: <code>false</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in each response (result page). It's used for a paginated request.</para><para>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARAutoScalingConfigurationListCmdlet.NextToken"> <summary> <para> <para>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.</para><para>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</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.AAR.GetAARAutoScalingConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoScalingConfigurationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.ListAutoScalingConfigurationsResponse). Specifying the name of a property of type Amazon.AppRunner.Model.ListAutoScalingConfigurationsResponse 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.AAR.GetAARAutoScalingConfigurationListCmdlet.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.AAR.GetAARConnectionListCmdlet"> <summary> Returns a list of App Runner connections that are associated with your Amazon Web Services account.<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.AAR.GetAARConnectionListCmdlet.ConnectionName"> <summary> <para> <para>If specified, only this connection is returned. If not specified, the result isn't filtered by name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARConnectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in each response (result page). Used for a paginated request.</para><para>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARConnectionListCmdlet.NextToken"> <summary> <para> <para>A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.</para><para>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</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.AAR.GetAARConnectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ConnectionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.ListConnectionsResponse). Specifying the name of a property of type Amazon.AppRunner.Model.ListConnectionsResponse 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.AAR.GetAARConnectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionName parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARConnectionListCmdlet.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.AAR.GetAARCustomDomainCmdlet"> <summary> Return a description of custom domain names that are associated with an App Runner service.<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.AAR.GetAARCustomDomainCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARCustomDomainCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that each response (result page) can include. It's used for a paginated request.</para><para>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARCustomDomainCmdlet.NextToken"> <summary> <para> <para>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.</para><para>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</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.AAR.GetAARCustomDomainCmdlet.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.AppRunner.Model.DescribeCustomDomainsResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DescribeCustomDomainsResponse 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.AAR.GetAARCustomDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARCustomDomainCmdlet.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.AAR.GetAAROperationListCmdlet"> <summary> Return a list of operations that occurred on an App Runner service. <para> The resulting list of <a>OperationSummary</a> objects is sorted in reverse chronological order. The first object on the list represents the last started operation. </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.AAR.GetAAROperationListCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAAROperationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in each response (result page). It's used for a paginated request.</para><para>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAAROperationListCmdlet.NextToken"> <summary> <para> <para>A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.</para><para>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</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.AAR.GetAAROperationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.ListOperationsResponse). Specifying the name of a property of type Amazon.AppRunner.Model.ListOperationsResponse 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.AAR.GetAAROperationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAAROperationListCmdlet.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.AAR.GetAARResourceTagCmdlet"> <summary> List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that a tag list is requested for.</para><para>It must be the ARN of an App Runner resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARResourceTagCmdlet.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.AppRunner.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.AppRunner.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="P:Amazon.PowerShell.Cmdlets.AAR.GetAARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAR.GetAARServiceCmdlet"> <summary> Return a full description of an App Runner service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARServiceCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want a description for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARServiceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Service'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.DescribeServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DescribeServiceResponse 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.AAR.GetAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AAR.GetAARServiceListCmdlet"> <summary> Returns a list of running App Runner services in your Amazon Web Services account.<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.AAR.GetAARServiceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in each response (result page). It's used for a paginated request.</para><para>If you don't specify <code>MaxResults</code>, the request retrieves all available results in a single response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.GetAARServiceListCmdlet.NextToken"> <summary> <para> <para>A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.</para><para>If you don't specify <code>NextToken</code>, the request retrieves the first result page.</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.AAR.GetAARServiceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.ListServicesResponse). Specifying the name of a property of type Amazon.AppRunner.Model.ListServicesResponse 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.AAR.GetAARServiceListCmdlet.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.AAR.NewAARAutoScalingConfigurationCmdlet"> <summary> Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling configuration across multiple services. <para> Create multiple revisions of a configuration by using the same <code>AutoScalingConfigurationName</code> and different <code>AutoScalingConfigurationRevision</code> values. When you create a service, you can set it to use the latest active revision of an auto scaling configuration or a specific revision. </para><para> Configure a higher <code>MinSize</code> to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost. </para><para> Configure a lower <code>MaxSize</code> to control your cost. The tradeoff is lower responsiveness during peak demand. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.AutoScalingConfigurationName"> <summary> <para> <para>A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number <code>1</code> of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.MaxConcurrency"> <summary> <para> <para>The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.</para><para>Default: <code>100</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.MaxSize"> <summary> <para> <para>The maximum number of instances that your service scales up to. At most <code>MaxSize</code> instances actively serve traffic for your service.</para><para>Default: <code>25</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.MinSize"> <summary> <para> <para>The minimum number of instances that App Runner provisions for your service. The service always has at least <code>MinSize</code> provisioned instances. Some of them actively serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the provisioned instances. You pay for CPU usage of only the active subset.</para><para>App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.</para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.Tag"> <summary> <para> <para>A list of metadata items that you can associate with your auto scaling configuration resource. A tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoScalingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.CreateAutoScalingConfigurationResponse). Specifying the name of a property of type Amazon.AppRunner.Model.CreateAutoScalingConfigurationResponse 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.AAR.NewAARAutoScalingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoScalingConfigurationName parameter. The -PassThru parameter is deprecated, use -Select '^AutoScalingConfigurationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARAutoScalingConfigurationCmdlet.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.AAR.NewAARConnectionCmdlet"> <summary> Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services. <para> A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARConnectionCmdlet.ConnectionName"> <summary> <para> <para>A name for the new connection. It must be unique across all App Runner connections for the Amazon Web Services account in the Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARConnectionCmdlet.ProviderType"> <summary> <para> <para>The source repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARConnectionCmdlet.Tag"> <summary> <para> <para>A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.CreateConnectionResponse). Specifying the name of a property of type Amazon.AppRunner.Model.CreateConnectionResponse 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.AAR.NewAARConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionName parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARConnectionCmdlet.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.AAR.NewAARServiceCmdlet"> <summary> Create an App Runner service. After the service is created, the action also automatically starts a deployment. <para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a href="https://docs.aws.amazon.com/apprunner/latest/api/API_ListOperations.html">ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.AuthenticationConfiguration_AccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.SourceConfiguration_AutoDeploymentsEnabled"> <summary> <para> <para>If <code>true</code>, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source code commit or new image version) starts a deployment.</para><para>Default: App Runner sets to <code>false</code> for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to <code>true</code> in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.AutoScalingConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfigurationValues_BuildCommand"> <summary> <para> <para>The command App Runner runs to build your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfiguration_ConfigurationSource"> <summary> <para> <para>The source of the App Runner configuration. Values are interpreted as follows:</para><ul><li><para><code>REPOSITORY</code> – App Runner reads configuration values from the <code>apprunner.yaml</code> file in the source code repository and ignores <code>CodeConfigurationValues</code>.</para></li><li><para><code>API</code> – App Runner uses configuration values provided in <code>CodeConfigurationValues</code> and ignores the <code>apprunner.yaml</code> file in the source code repository.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.AuthenticationConfiguration_ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.InstanceConfiguration_Cpu"> <summary> <para> <para>The number of CPU units reserved for each instance of your App Runner service.</para><para>Default: <code>1 vCPU</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_HealthyThreshold"> <summary> <para> <para>The number of consecutive checks that must succeed before App Runner decides that the service is healthy.</para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ImageRepository_ImageIdentifier"> <summary> <para> <para>The identifier of an image.</para><para>For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an image</a> in the <i>Amazon ECR User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ImageRepository_ImageRepositoryType"> <summary> <para> <para>The type of the image repository. This reflects the repository provider and whether the repository is private or public.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.InstanceConfiguration_InstanceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any Amazon Web Services APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_Interval"> <summary> <para> <para>The time interval, in seconds, between health checks.</para><para>Default: <code>5</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.EncryptionConfiguration_KmsKey"> <summary> <para> <para>The ARN of the KMS key that's used for encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.InstanceConfiguration_Memory"> <summary> <para> <para>The amount of memory, in MB or GB, reserved for each instance of your App Runner service.</para><para>Default: <code>2 GB</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_Path"> <summary> <para> <para>The URL that health check requests are sent to.</para><para><code>Path</code> is only applicable when you set <code>Protocol</code> to <code>HTTP</code>.</para><para>Default: <code>"/"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfigurationValues_Port"> <summary> <para> <para>The port that your application listens to in the container.</para><para>Default: <code>8080</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ImageConfiguration_Port"> <summary> <para> <para>The port that your application listens to in the container.</para><para>Default: <code>8080</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_Protocol"> <summary> <para> <para>The IP protocol that App Runner uses to perform health checks for your service.</para><para>If you set <code>Protocol</code> to <code>HTTP</code>, App Runner sends health check requests to the HTTP path specified by <code>Path</code>.</para><para>Default: <code>TCP</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeRepository_RepositoryUrl"> <summary> <para> <para>The location of the repository that contains the source code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfigurationValues_Runtime"> <summary> <para> <para>A runtime environment type for building and running an App Runner service. It represents a programming language runtime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfigurationValues_RuntimeEnvironmentVariable"> <summary> <para> <para>The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of <code>AWSAPPRUNNER</code> are reserved for system use and aren't valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ImageConfiguration_RuntimeEnvironmentVariable"> <summary> <para> <para>Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of <code>AWSAPPRUNNER</code> are reserved for system use and aren't valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ServiceName"> <summary> <para> <para>A name for the new service. It must be unique across all the running App Runner services in your Amazon Web Services account in the Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.CodeConfigurationValues_StartCommand"> <summary> <para> <para>The command App Runner runs to start your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.ImageConfiguration_StartCommand"> <summary> <para> <para>An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with your service resource. A tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_Timeout"> <summary> <para> <para>The time, in seconds, to wait for a health check response before deciding it failed.</para><para>Default: <code>2</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.SourceCodeVersion_Type"> <summary> <para> <para>The type of version identifier.</para><para>For a git-based repository, branches represent versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.HealthCheckConfiguration_UnhealthyThreshold"> <summary> <para> <para>The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.</para><para>Default: <code>5</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.SourceCodeVersion_Value"> <summary> <para> <para>A source code version.</para><para>For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.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.AppRunner.Model.CreateServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.CreateServiceResponse 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.AAR.NewAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceName parameter. The -PassThru parameter is deprecated, use -Select '^ServiceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.NewAARServiceCmdlet.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.AAR.RemoveAARAutoScalingConfigurationCmdlet"> <summary> Delete an App Runner automatic scaling configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or more App Runner services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARAutoScalingConfigurationCmdlet.AutoScalingConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.</para><para>The ARN can be a full auto scaling configuration ARN, or a partial ARN ending with either <code>.../<i>name</i></code> or <code>.../<i>name</i>/<i>revision</i></code>. If a revision isn't specified, the latest active revision is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARAutoScalingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoScalingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.DeleteAutoScalingConfigurationResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DeleteAutoScalingConfigurationResponse 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.AAR.RemoveAARAutoScalingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoScalingConfigurationArn parameter. The -PassThru parameter is deprecated, use -Select '^AutoScalingConfigurationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARAutoScalingConfigurationCmdlet.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.AAR.RemoveAARConnectionCmdlet"> <summary> Delete an App Runner connection. You must first ensure that there are no running App Runner services that use this connection. If there are any, the <code>DeleteConnection</code> action fails. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARConnectionCmdlet.ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Connection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.DeleteConnectionResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DeleteConnectionResponse 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.AAR.RemoveAARConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ConnectionArn parameter. The -PassThru parameter is deprecated, use -Select '^ConnectionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARConnectionCmdlet.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.AAR.RemoveAARCustomDomainCmdlet"> <summary> Disassociate a custom domain name from an App Runner service. <para> Certificates tracking domain validity are associated with a custom domain and are stored in <a href="https://docs.aws.amazon.com/acm/latest/userguide">AWS Certificate Manager (ACM)</a>. These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARCustomDomainCmdlet.DomainName"> <summary> <para> <para>The domain name that you want to disassociate from the App Runner service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARCustomDomainCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARCustomDomainCmdlet.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.AppRunner.Model.DisassociateCustomDomainResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DisassociateCustomDomainResponse 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.AAR.RemoveAARCustomDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARCustomDomainCmdlet.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.AAR.RemoveAARResourceTagCmdlet"> <summary> Remove tags from an App Runner resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</para><para>It must be the ARN of an App Runner resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARResourceTagCmdlet.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.AppRunner.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARResourceTagCmdlet.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.AAR.RemoveAARServiceCmdlet"> <summary> Delete an App Runner service. <para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARServiceCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARServiceCmdlet.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.AppRunner.Model.DeleteServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.DeleteServiceResponse 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.AAR.RemoveAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.RemoveAARServiceCmdlet.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.AAR.ResumeAARServiceCmdlet"> <summary> Resume an active App Runner service. App Runner provisions compute capacity for the service. <para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.ResumeAARServiceCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to resume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.ResumeAARServiceCmdlet.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.AppRunner.Model.ResumeServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.ResumeServiceResponse 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.AAR.ResumeAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.ResumeAARServiceCmdlet.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.AAR.StartAARDeploymentCmdlet"> <summary> Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service. <para> For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance. </para><para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.StartAARDeploymentCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to manually deploy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.StartAARDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppRunner.Model.StartDeploymentResponse). Specifying the name of a property of type Amazon.AppRunner.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.AAR.StartAARDeploymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.StartAARDeploymentCmdlet.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.AAR.SuspendAARServiceCmdlet"> <summary> Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed). <para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.SuspendAARServiceCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to pause.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.SuspendAARServiceCmdlet.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.AppRunner.Model.PauseServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.PauseServiceResponse 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.AAR.SuspendAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.SuspendAARServiceCmdlet.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.AAR.UpdateAARServiceCmdlet"> <summary> Update an App Runner service. You can update the source configuration and instance configuration of the service. You can also update the ARN of the auto scaling configuration resource that's associated with the service. However, you can't change the name or the encryption configuration of the service. These can be set only when you create the service. <para> To update the tags applied to your service, use the separate actions <a>TagResource</a> and <a>UntagResource</a>. </para><para> This is an asynchronous operation. On a successful call, you can use the returned <code>OperationId</code> and the <a>ListOperations</a> call to track the operation's progress. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.AuthenticationConfiguration_AccessRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR Public repositories).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.SourceConfiguration_AutoDeploymentsEnabled"> <summary> <para> <para>If <code>true</code>, continuous integration from the source repository is enabled for the App Runner service. Each repository change (including any source code commit or new image version) starts a deployment.</para><para>Default: App Runner sets to <code>false</code> for a source image that uses an ECR Public repository or an ECR repository that's in an Amazon Web Services account other than the one that the service is in. App Runner sets to <code>true</code> in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.AutoScalingConfigurationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfigurationValues_BuildCommand"> <summary> <para> <para>The command App Runner runs to build your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfiguration_ConfigurationSource"> <summary> <para> <para>The source of the App Runner configuration. Values are interpreted as follows:</para><ul><li><para><code>REPOSITORY</code> – App Runner reads configuration values from the <code>apprunner.yaml</code> file in the source code repository and ignores <code>CodeConfigurationValues</code>.</para></li><li><para><code>API</code> – App Runner uses configuration values provided in <code>CodeConfigurationValues</code> and ignores the <code>apprunner.yaml</code> file in the source code repository.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.AuthenticationConfiguration_ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.InstanceConfiguration_Cpu"> <summary> <para> <para>The number of CPU units reserved for each instance of your App Runner service.</para><para>Default: <code>1 vCPU</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_HealthyThreshold"> <summary> <para> <para>The number of consecutive checks that must succeed before App Runner decides that the service is healthy.</para><para>Default: <code>1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ImageRepository_ImageIdentifier"> <summary> <para> <para>The identifier of an image.</para><para>For an image in Amazon Elastic Container Registry (Amazon ECR), this is an image name. For the image name format, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html">Pulling an image</a> in the <i>Amazon ECR User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ImageRepository_ImageRepositoryType"> <summary> <para> <para>The type of the image repository. This reflects the repository provider and whether the repository is private or public.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.InstanceConfiguration_InstanceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any Amazon Web Services APIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_Interval"> <summary> <para> <para>The time interval, in seconds, between health checks.</para><para>Default: <code>5</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.InstanceConfiguration_Memory"> <summary> <para> <para>The amount of memory, in MB or GB, reserved for each instance of your App Runner service.</para><para>Default: <code>2 GB</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_Path"> <summary> <para> <para>The URL that health check requests are sent to.</para><para><code>Path</code> is only applicable when you set <code>Protocol</code> to <code>HTTP</code>.</para><para>Default: <code>"/"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfigurationValues_Port"> <summary> <para> <para>The port that your application listens to in the container.</para><para>Default: <code>8080</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ImageConfiguration_Port"> <summary> <para> <para>The port that your application listens to in the container.</para><para>Default: <code>8080</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_Protocol"> <summary> <para> <para>The IP protocol that App Runner uses to perform health checks for your service.</para><para>If you set <code>Protocol</code> to <code>HTTP</code>, App Runner sends health check requests to the HTTP path specified by <code>Path</code>.</para><para>Default: <code>TCP</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeRepository_RepositoryUrl"> <summary> <para> <para>The location of the repository that contains the source code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfigurationValues_Runtime"> <summary> <para> <para>A runtime environment type for building and running an App Runner service. It represents a programming language runtime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfigurationValues_RuntimeEnvironmentVariable"> <summary> <para> <para>The environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of <code>AWSAPPRUNNER</code> are reserved for system use and aren't valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ImageConfiguration_RuntimeEnvironmentVariable"> <summary> <para> <para>Environment variables that are available to your running App Runner service. An array of key-value pairs. Keys with a prefix of <code>AWSAPPRUNNER</code> are reserved for system use and aren't valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ServiceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the App Runner service that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.CodeConfigurationValues_StartCommand"> <summary> <para> <para>The command App Runner runs to start your application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.ImageConfiguration_StartCommand"> <summary> <para> <para>An optional command that App Runner runs to start the application in the source image. If specified, this command overrides the Docker image’s default start command.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_Timeout"> <summary> <para> <para>The time, in seconds, to wait for a health check response before deciding it failed.</para><para>Default: <code>2</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.SourceCodeVersion_Type"> <summary> <para> <para>The type of version identifier.</para><para>For a git-based repository, branches represent versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.HealthCheckConfiguration_UnhealthyThreshold"> <summary> <para> <para>The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.</para><para>Default: <code>5</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.SourceCodeVersion_Value"> <summary> <para> <para>A source code version.</para><para>For a git-based repository, a branch name maps to a specific version. App Runner uses the most recent commit to the branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.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.AppRunner.Model.UpdateServiceResponse). Specifying the name of a property of type Amazon.AppRunner.Model.UpdateServiceResponse 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.AAR.UpdateAARServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceArn parameter. The -PassThru parameter is deprecated, use -Select '^ServiceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AAR.UpdateAARServiceCmdlet.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> |