AWS.Tools.Proton.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Proton</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet"> <summary> Tag a resource. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.Tag"> <summary> <para> <para>An array of resource tags to apply to a resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.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.Proton.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.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.PRO.AddPROResourceTagCmdlet.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.PRO.ApprovePROEnvironmentAccountConnectionCmdlet"> <summary> In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account. <para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.ApprovePROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.ApprovePROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.AcceptEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.AcceptEnvironmentAccountConnectionResponse 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.PRO.ApprovePROEnvironmentAccountConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.ApprovePROEnvironmentAccountConnectionCmdlet.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.PRO.DenyPROEnvironmentAccountConnectionCmdlet"> <summary> In a management account, reject an environment account connection from another environment account. <para> After you reject an environment account connection request, you <i>won’t</i> be able to accept or use the rejected environment account connection. </para><para> You <i>can’t</i> reject an environment account connection that is connected to an environment. </para><para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.DenyPROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection to reject.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.DenyPROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.RejectEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.RejectEnvironmentAccountConnectionResponse 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.PRO.DenyPROEnvironmentAccountConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.DenyPROEnvironmentAccountConnectionCmdlet.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.PRO.GetPROAccountSettingCmdlet"> <summary> Get detail data for the AWS Proton pipeline service role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetAccountSettingsResponse). Specifying the name of a property of type Amazon.Proton.Model.GetAccountSettingsResponse 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.PRO.GetPROEnvironmentCmdlet"> <summary> Get detail data for an environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment that you want to get the detail data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetEnvironmentResponse). Specifying the name of a property of type Amazon.Proton.Model.GetEnvironmentResponse 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.PRO.GetPROEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionCmdlet"> <summary> In an environment account, view the detail data for an environment account connection. <para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.GetEnvironmentAccountConnectionResponse 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.PRO.GetPROEnvironmentAccountConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet"> <summary> View a list of environment account connections. <para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.EnvironmentName"> <summary> <para> <para>The environment name that's associated with each listed environment account connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.RequestedBy"> <summary> <para> <para>The type of account making the <code>ListEnvironmentAccountConnections</code> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.Status"> <summary> <para> <para>The status details for each listed environment account connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of environment account connections to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentAccountConnectionsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentAccountConnectionsResponse 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.PRO.GetPROEnvironmentAccountConnectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RequestedBy parameter. The -PassThru parameter is deprecated, use -Select '^RequestedBy' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentListCmdlet"> <summary> List environments with detail data summaries. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentListCmdlet.EnvironmentTemplate"> <summary> <para> <para>An array of the versions of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of environments to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentsResponse 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.PRO.GetPROEnvironmentTemplateCmdlet"> <summary> Get detail data for an environment template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateCmdlet.Name"> <summary> <para> <para>The name of the environment template that you want to get the detail data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetEnvironmentTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.GetEnvironmentTemplateResponse 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.PRO.GetPROEnvironmentTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateListCmdlet"> <summary> List environment templates. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of environment templates to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Templates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentTemplatesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentTemplatesResponse 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.PRO.GetPROEnvironmentTemplateVersionCmdlet"> <summary> View detail data for a major or minor version of an environment template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To view environment template major version detail data, include <code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To view environment template minor version detail data, include <code>minorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetEnvironmentTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.GetEnvironmentTemplateVersionResponse 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.PRO.GetPROEnvironmentTemplateVersionListCmdlet"> <summary> List major or minor versions of an environment template with detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionListCmdlet.MajorVersion"> <summary> <para> <para>To view a list of minor of versions under a major version of an environment template, include <code>majorVersion</code>.</para><para>To view a list of major versions of an environment template, <i>exclude</i><code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionListCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of major or minor versions of an environment template to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentTemplateVersionsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentTemplateVersionsResponse 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.PRO.GetPROEnvironmentTemplateVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateName parameter. The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet"> <summary> List tags for a resource. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource for the listed tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tags to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet.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.Proton.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Proton.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.PRO.GetPROResourceTagCmdlet.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.PRO.GetPROServiceCmdlet"> <summary> Get detail data for a service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceCmdlet.Name"> <summary> <para> <para>The name of the service that you want to get the detail data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceCmdlet.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.Proton.Model.GetServiceResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceResponse 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.PRO.GetPROServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceCmdlet"> <summary> Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceCmdlet.Name"> <summary> <para> <para>The name of a service instance that you want to get the detail data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceCmdlet.ServiceName"> <summary> <para> <para>The name of the service that the service instance belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceInstanceResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceInstanceResponse 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.PRO.GetPROServiceInstanceListCmdlet"> <summary> List service instances with summaries of detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.ServiceName"> <summary> <para> <para>The name of the service that the service instance belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of service instances to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServiceInstancesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServiceInstancesResponse 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.PRO.GetPROServiceInstanceListCmdlet.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="T:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceListCmdlet"> <summary> List services with summaries of detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of services to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Services'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServicesResponse). Specifying the name of a property of type Amazon.Proton.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="T:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateCmdlet"> <summary> Get detail data for a service template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateCmdlet.Name"> <summary> <para> <para>The name of the service template that you want to get detail data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceTemplateResponse 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.PRO.GetPROServiceTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateListCmdlet"> <summary> List service templates with detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of service templates to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Templates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServiceTemplatesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServiceTemplatesResponse 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.PRO.GetPROServiceTemplateVersionCmdlet"> <summary> View detail data for a major or minor version of a service template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To view service template major version detail data, include <code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To view service template minor version detail data, include <code>minorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceTemplateVersionResponse 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.PRO.GetPROServiceTemplateVersionListCmdlet"> <summary> List major or minor versions of a service template with detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionListCmdlet.MajorVersion"> <summary> <para> <para>To view a list of minor of versions under a major version of a service template, include <code>majorVersion</code>.</para><para>To view a list of major versions of a service template, <i>exclude</i><code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionListCmdlet.TemplateName"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of major or minor versions of a service template to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionListCmdlet.NextToken"> <summary> <para> <para>A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServiceTemplateVersionsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServiceTemplateVersionsResponse 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.PRO.GetPROServiceTemplateVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateName parameter. The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet"> <summary> Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html">Environments</a> in the <i>AWS Proton Administration Guide.</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Description"> <summary> <para> <para>A description of the environment that's being created and deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.EnvironmentAccountConnectionId"> <summary> <para> <para>The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.ProtonServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Spec"> <summary> <para> <para>A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-managing-environments.html">Environments</a> in the <i>AWS Proton Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Tag"> <summary> <para> <para>Create tags for your environment. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.TemplateMajorVersion"> <summary> <para> <para>The ID of the major version of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.TemplateMinorVersion"> <summary> <para> <para>The ID of the minor version of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html">Environment Templates</a> in the <i>AWS Proton Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateEnvironmentResponse 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.PRO.NewPROEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.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.PRO.NewPROEnvironmentAccountConnectionCmdlet"> <summary> Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from the management account. <para> An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment account</i> that maintains authorization and permissions. For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.EnvironmentName"> <summary> <para> <para>The name of the AWS Proton environment that's created in the associated management account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.ManagementAccountId"> <summary> <para> <para>The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.ClientToken"> <summary> <para> <para>When included, if two identicial requests are made with the same client token, AWS Proton returns the environment account connection that the first request created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateEnvironmentAccountConnectionResponse 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.PRO.NewPROEnvironmentAccountConnectionCmdlet.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.PRO.NewPROEnvironmentTemplateCmdlet"> <summary> Create an environment template for AWS Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html">Environment Templates</a> in the <i>AWS Proton Administration Guide</i>. <para> You can create an environment template in one of the two following ways: </para><ul><li><para> Register and publish a <i>standard</i> environment template that instructs AWS Proton to deploy and manage environment infrastructure. </para></li><li><para> Register and publish a <i>customer managed</i> environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/env-template-v1.html">Register and publish an environment template</a> in the <i>AWS Proton Administration Guide</i>. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.Description"> <summary> <para> <para>A description of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.DisplayName"> <summary> <para> <para>The environment template name as displayed in the developer interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.EncryptionKey"> <summary> <para> <para>A customer provided encryption key that AWS Proton uses to encrypt data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.Name"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.Provisioning"> <summary> <para> <para>When included, indicates that the environment template is for customer provisioned and managed infrastructure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.Tag"> <summary> <para> <para>Create tags for your environment template. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateEnvironmentTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateEnvironmentTemplateResponse 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.PRO.NewPROEnvironmentTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateCmdlet.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.PRO.NewPROEnvironmentTemplateVersionCmdlet"> <summary> Create a new major or minor version of an environment template. A major version of an environment template is a version that <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.S3_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains a template bundle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.Description"> <summary> <para> <para>A description of the new version of an environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.S3_Key"> <summary> <para> <para>The path to the S3 bucket that contains a template bundle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To create a new minor version of the environment template, include a <code>majorVersion</code>.</para><para>To create a new major and minor version of the environment template, exclude <code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.Tag"> <summary> <para> <para>Create tags for a new version of an environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.ClientToken"> <summary> <para> <para>When included, if two identicial requests are made with the same client token, AWS Proton returns the environment template version that the first request created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateEnvironmentTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateEnvironmentTemplateVersionResponse 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.PRO.NewPROEnvironmentTemplateVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateName parameter. The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.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.PRO.NewPROServiceCmdlet"> <summary> Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html">Services</a> in the <i>AWS Proton Administration Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html">Services</a> in the <i>AWS Proton User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.BranchName"> <summary> <para> <para>The name of the code repository branch that holds the code that's deployed in AWS Proton. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.Description"> <summary> <para> <para>A description of the AWS Proton service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.Name"> <summary> <para> <para>The service name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.RepositoryConnectionArn"> <summary> <para> <para>The ARN of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#settingSS-up-vcontrol">Set up repository connection</a> in the <i>AWS Proton Administration Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-getting-started.html#getting-started-step1">Getting started</a> in the <i>AWS Proton User Guide</i>. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.RepositoryId"> <summary> <para> <para>The ID of the code repository. <i>Don't</i> include this parameter if your service template <i>doesn't</i> include a service pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.Spec"> <summary> <para> <para>A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html.html">Create a service</a> in the <i>AWS Proton Administration Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html">Create a service</a> in the <i>AWS Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.Tag"> <summary> <para> <para>Create tags for your service. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.TemplateMajorVersion"> <summary> <para> <para>The ID of the major version of the service template that was used to create the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.TemplateMinorVersion"> <summary> <para> <para>The ID of the minor version of the service template that was used to create the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.TemplateName"> <summary> <para> <para>The name of the service template that's used to create the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.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.Proton.Model.CreateServiceResponse). Specifying the name of a property of type Amazon.Proton.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.PRO.NewPROServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.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.PRO.NewPROServiceTemplateCmdlet"> <summary> Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html">Service Templates</a> in the <i>AWS Proton Administration Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.Description"> <summary> <para> <para>A description of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.DisplayName"> <summary> <para> <para>The name of the service template as displayed in the developer interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.EncryptionKey"> <summary> <para> <para>A customer provided encryption key that's used to encrypt data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.Name"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.PipelineProvisioning"> <summary> <para> <para>AWS Proton includes a service pipeline for your service by default. When included, this parameter indicates that an AWS Proton service pipeline <i>won't</i> be included for your service. Once specified, this parameter <i>can't</i> be changed. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-template-bundles.html">Service template bundles</a> in the <i>AWS Proton Administration Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.Tag"> <summary> <para> <para>Create tags for your service template. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateServiceTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateServiceTemplateResponse 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.PRO.NewPROServiceTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.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.PRO.NewPROServiceTemplateVersionCmdlet"> <summary> Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i> backwards compatible. A minor version of a service template is a version that's backwards compatible within its major version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.S3_Bucket"> <summary> <para> <para>The name of the S3 bucket that contains a template bundle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.CompatibleEnvironmentTemplate"> <summary> <para> <para>An array of compatible environment template objects for the new version of a service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.Description"> <summary> <para> <para>A description of the new version of a service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.S3_Key"> <summary> <para> <para>The path to the S3 bucket that contains a template bundle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To create a new minor version of the service template, include a <code>majorVersion</code>.</para><para>To create a new major and minor version of the service template, <i>exclude</i><code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.Tag"> <summary> <para> <para>Create tags for a new version of a service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.ClientToken"> <summary> <para> <para>When included, if two identicial requests are made with the same client token, AWS Proton returns the service template version that the first request created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateServiceTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateServiceTemplateVersionResponse 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.PRO.NewPROServiceTemplateVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateName parameter. The -PassThru parameter is deprecated, use -Select '^TemplateName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.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.PRO.RemovePROEnvironmentCmdlet"> <summary> Delete an environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteEnvironmentResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteEnvironmentResponse 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.PRO.RemovePROEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentCmdlet.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.PRO.RemovePROEnvironmentAccountConnectionCmdlet"> <summary> In an environment account, delete an environment account connection. <para> After you delete an environment account connection that’s in use by an AWS Proton environment, AWS Proton <i>can’t</i> manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection. </para><para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteEnvironmentAccountConnectionResponse 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.PRO.RemovePROEnvironmentAccountConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentAccountConnectionCmdlet.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.PRO.RemovePROEnvironmentTemplateCmdlet"> <summary> If no other major or minor versions of an environment template exist, delete the environment template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateCmdlet.Name"> <summary> <para> <para>The name of the environment template to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteEnvironmentTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteEnvironmentTemplateResponse 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.PRO.RemovePROEnvironmentTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateCmdlet.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.PRO.RemovePROEnvironmentTemplateVersionCmdlet"> <summary> If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the <code>Recommended</code> version. Delete the <code>Recommended</code> version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backwards compatible. <para> Delete a minor version of an environment template if it <i>isn't</i> the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backwards compatible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>The environment template major version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>The environment template minor version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROEnvironmentTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteEnvironmentTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteEnvironmentTemplateVersionResponse 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.PRO.RemovePROEnvironmentTemplateVersionCmdlet.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.PRO.RemovePROResourceTagCmdlet"> <summary> Remove a tag from a resource. For more information, see <i>AWS Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">AWS Proton Administration Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">AWS Proton User Guide</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.TagKey"> <summary> <para> <para>An array of tag keys indicating the resource tags to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.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.Proton.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.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.PRO.RemovePROResourceTagCmdlet.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.PRO.RemovePROServiceCmdlet"> <summary> Delete a service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceCmdlet.Name"> <summary> <para> <para>The name of the service to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceCmdlet.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.Proton.Model.DeleteServiceResponse). Specifying the name of a property of type Amazon.Proton.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.PRO.RemovePROServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceCmdlet.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.PRO.RemovePROServiceTemplateCmdlet"> <summary> If no other major or minor versions of the service template exist, delete the service template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateCmdlet.Name"> <summary> <para> <para>The name of the service template to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteServiceTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteServiceTemplateResponse 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.PRO.RemovePROServiceTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateCmdlet.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.PRO.RemovePROServiceTemplateVersionCmdlet"> <summary> If no other minor versions of a service template exist, delete a major version of the service template if it's not the <code>Recommended</code> version. Delete the <code>Recommended</code> version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that <i>isn't</i> backwards compatible. <para> Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>The service template major version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>The service template minor version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteServiceTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteServiceTemplateVersionResponse 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.PRO.RemovePROServiceTemplateVersionCmdlet.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.PRO.StopPROEnvironmentDeploymentCmdlet"> <summary> Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html">Update an environment</a> in the <i>AWS Proton Administration guide</i>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>. </para></li><li><para> If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROEnvironmentDeploymentCmdlet.EnvironmentName"> <summary> <para> <para>The name of the environment with the deployment to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROEnvironmentDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CancelEnvironmentDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.CancelEnvironmentDeploymentResponse 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.PRO.StopPROEnvironmentDeploymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentName parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROEnvironmentDeploymentCmdlet.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.PRO.StopPROServiceInstanceDeploymentCmdlet"> <summary> Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <i>Update a service instance</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html">AWS Proton Administration guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html">AWS Proton User guide</a>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>. </para></li><li><para> If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROServiceInstanceDeploymentCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance with the deployment to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROServiceInstanceDeploymentCmdlet.ServiceName"> <summary> <para> <para>The name of the service with the service instance deployment to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROServiceInstanceDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse 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.PRO.StopPROServiceInstanceDeploymentCmdlet.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.PRO.StopPROServicePipelineDeploymentCmdlet"> <summary> Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For more information, see <i>Update a service pipeline</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html">AWS Proton Administration guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html">AWS Proton User guide</a>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>. </para></li><li><para> If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and the cancellation attempt has no effect. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROServicePipelineDeploymentCmdlet.ServiceName"> <summary> <para> <para>The name of the service with the service pipeline deployment to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROServicePipelineDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CancelServicePipelineDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.CancelServicePipelineDeploymentResponse 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.PRO.StopPROServicePipelineDeploymentCmdlet.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.PRO.StopPROServicePipelineDeploymentCmdlet.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.PRO.UpdatePROAccountSettingCmdlet"> <summary> Update the AWS Proton pipeline service account settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateAccountSettingsResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateAccountSettingsResponse 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.PRO.UpdatePROAccountSettingCmdlet.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.PRO.UpdatePROEnvironmentCmdlet"> <summary> Update an environment. <para> If the environment is associated with an environment account connection, <i>don't</i> update or include the <code>protonServiceRoleArn</code> parameter to update or connect to an environment account connection. </para><para> You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and associated with the current environment. </para><para> If the environment <i>isn't</i> associated with an environment account connection, <i>don't</i> update or include the <code>environmentAccountConnectionId</code> parameter to update or connect to an environment account connection. </para><para> You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t update both. </para><para> There are four modes for updating an environment as described in the following. The <code>deploymentType</code> field defines the mode. </para><dl><dt /><dd><para><code>NONE</code></para><para> In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. </para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para> In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>. </para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para> In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use. </para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para> In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional). </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.DeploymentType"> <summary> <para> <para>There are four modes for updating an environment as described in the following. The <code>deploymentType</code> field defines the mode.</para><dl><dt /><dd><para><code>NONE</code></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.Description"> <summary> <para> <para>A description of the environment update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.EnvironmentAccountConnectionId"> <summary> <para> <para>The ID of the environment account connection.</para><para>You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and associated with the current environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.ProtonServiceRoleArn"> <summary> <para> <para>The ARN of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.Spec"> <summary> <para> <para>The formatted specification that defines the update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.TemplateMajorVersion"> <summary> <para> <para>The ID of the major version of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.TemplateMinorVersion"> <summary> <para> <para>The ID of the minor version of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateEnvironmentResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateEnvironmentResponse 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.PRO.UpdatePROEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.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.PRO.UpdatePROEnvironmentAccountConnectionCmdlet"> <summary> In an environment account, update an environment account connection to use a new IAM role. <para> For more information, see <a href="proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>AWS Proton Administration guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentAccountConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateEnvironmentAccountConnectionResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateEnvironmentAccountConnectionResponse 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.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.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.PRO.UpdatePROEnvironmentTemplateCmdlet"> <summary> Update an environment template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateCmdlet.Description"> <summary> <para> <para>A description of the environment template update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateCmdlet.DisplayName"> <summary> <para> <para>The name of the environment template to update as displayed in the developer interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateCmdlet.Name"> <summary> <para> <para>The name of the environment template to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateEnvironmentTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateEnvironmentTemplateResponse 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.PRO.UpdatePROEnvironmentTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateCmdlet.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.PRO.UpdatePROEnvironmentTemplateVersionCmdlet"> <summary> Update a major or minor version of an environment template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.Description"> <summary> <para> <para>A description of environment template version to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To update a major version of an environment template, include <code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To update a minor version of an environment template, include <code>minorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.Status"> <summary> <para> <para>The status of the environment template minor version to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnvironmentTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateEnvironmentTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateEnvironmentTemplateVersionResponse 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.PRO.UpdatePROEnvironmentTemplateVersionCmdlet.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.PRO.UpdatePROServiceCmdlet"> <summary> Edit a service description or use a spec to add and delete service instances. <note><para> Existing service instances and the service pipeline <i>can't</i> be edited using this API. They can only be deleted. </para></note><para> Use the <code>description</code> parameter to modify the description. </para><para> Edit the <code>spec</code> parameter to add or delete instances. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceCmdlet.Description"> <summary> <para> <para>The edited service description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceCmdlet.Name"> <summary> <para> <para>The name of the service to edit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceCmdlet.Spec"> <summary> <para> <para>Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. <i>Don't</i> include edits to the existing service instances or pipeline. For more information, see <i>Edit a service</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html">AWS Proton Administration Guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html">AWS Proton User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceCmdlet.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.Proton.Model.UpdateServiceResponse). Specifying the name of a property of type Amazon.Proton.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.PRO.UpdatePROServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceCmdlet.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.PRO.UpdatePROServiceInstanceCmdlet"> <summary> Update a service instance. <para> There are four modes for updating a service instance as described in the following. The <code>deploymentType</code> field defines the mode. </para><dl><dt /><dd><para><code>NONE</code></para><para> In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. </para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para> In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>. </para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para> In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use. </para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para> In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional). </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.DeploymentType"> <summary> <para> <para>The deployment type.</para><para>There are four modes for updating a service instance as described in the following. The <code>deploymentType</code> field defines the mode.</para><dl><dt /><dd><para><code>NONE</code></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para>In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.Name"> <summary> <para> <para>The name of the service instance to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.ServiceName"> <summary> <para> <para>The name of the service that the service instance belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.Spec"> <summary> <para> <para>The formatted specification that defines the service instance update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.TemplateMajorVersion"> <summary> <para> <para>The major version of the service template to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.TemplateMinorVersion"> <summary> <para> <para>The minor version of the service template to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServiceInstanceResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServiceInstanceResponse 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.PRO.UpdatePROServiceInstanceCmdlet.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.PRO.UpdatePROServicePipelineCmdlet"> <summary> Update the service pipeline. <para> There are four modes for updating a service pipeline as described in the following. The <code>deploymentType</code> field defines the mode. </para><dl><dt /><dd><para><code>NONE</code></para><para> In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. </para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para> In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>. </para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para> In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use. </para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para> In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional). </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.DeploymentType"> <summary> <para> <para>The deployment type.</para><para>There are four modes for updating a service pipeline as described in the following. The <code>deploymentType</code> field defines the mode.</para><dl><dt /><dd><para><code>NONE</code></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><code>CURRENT_VERSION</code></para><para>In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</para></dd><dt /><dd><para><code>MINOR_VERSION</code></para><para>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</para></dd><dt /><dd><para><code>MAJOR_VERSION</code></para><para>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.ServiceName"> <summary> <para> <para>The name of the service to that the pipeline is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.Spec"> <summary> <para> <para>The spec for the service pipeline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.TemplateMajorVersion"> <summary> <para> <para>The major version of the service template that was used to create the service that the pipeline is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.TemplateMinorVersion"> <summary> <para> <para>The minor version of the service template that was used to create the service that the pipeline is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServicePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServicePipelineResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServicePipelineResponse 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.PRO.UpdatePROServicePipelineCmdlet.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.PRO.UpdatePROServicePipelineCmdlet.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.PRO.UpdatePROServiceTemplateCmdlet"> <summary> Update a service template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateCmdlet.Description"> <summary> <para> <para>A description of the service template update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateCmdlet.DisplayName"> <summary> <para> <para>The name of the service template to update as displayed in the developer interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateCmdlet.Name"> <summary> <para> <para>The name of the service template to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplate'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServiceTemplateResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServiceTemplateResponse 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.PRO.UpdatePROServiceTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateCmdlet.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.PRO.UpdatePROServiceTemplateVersionCmdlet"> <summary> Update a major or minor version of a service template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.CompatibleEnvironmentTemplate"> <summary> <para> <para>An array of compatible environment names for a service template major or minor version to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.Description"> <summary> <para> <para>A description of a service template version to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.MajorVersion"> <summary> <para> <para>To update a major version of a service template, include <code>majorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To update a minor version of a service template, include <code>minorVersion</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.Status"> <summary> <para> <para>The status of the service template minor version to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the service template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceTemplateVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceTemplateVersion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServiceTemplateVersionResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServiceTemplateVersionResponse 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.PRO.UpdatePROServiceTemplateVersionCmdlet.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> |