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. A tag is a key-value pair of metadata that you associate with an Proton resource. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.AddPROResourceTagCmdlet.Tag"> <summary> <para> <para>A list of customer tags to apply to the Proton 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, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User 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>can't</i> accept or use the rejected environment account connection. </para><para> You <i>can’t</i> reject an environment account connection that's connected to an environment. </para><para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User 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.EditPROResourceDeploymentStatusChangeCmdlet"> <summary> Notify Proton of status changes to a provisioned resource when you use self-managed provisioning. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.DeploymentId"> <summary> <para> <para>The deployment ID for your provisioned resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.Output"> <summary> <para> <para>The provisioned resource state change detail data that's returned by Proton.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.ResourceArn"> <summary> <para> <para>The provisioned resource Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.Status"> <summary> <para> <para>The status of your provisioned resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.StatusMessage"> <summary> <para> <para>The deployment status message for your provisioned resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.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.NotifyResourceDeploymentStatusChangeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.EditPROResourceDeploymentStatusChangeCmdlet.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 Proton account-wide settings. </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.GetPROComponentCmdlet"> <summary> Get detailed data for a component. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentCmdlet.Name"> <summary> <para> <para>The name of the component that you want to get the detailed data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetComponentResponse). Specifying the name of a property of type Amazon.Proton.Model.GetComponentResponse 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.GetPROComponentCmdlet.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.GetPROComponentListCmdlet"> <summary> List components with summary data. You can filter the result list by environment, service, or a single service instance. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.EnvironmentName"> <summary> <para> <para>The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.ServiceName"> <summary> <para> <para>The name of a service for result list filtering. Proton returns components attached to service instances of the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of components to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Components'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListComponentsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListComponentsResponse 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.GetPROComponentOutputListCmdlet"> <summary> Get a list of component Infrastructure as Code (IaC) outputs. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentOutputListCmdlet.ComponentName"> <summary> <para> <para>The name of the component whose outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentOutputListCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment whose outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentOutputListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentOutputListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Outputs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListComponentOutputsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListComponentOutputsResponse 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.GetPROComponentOutputListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComponentName parameter. The -PassThru parameter is deprecated, use -Select '^ComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentProvisionedResourceListCmdlet"> <summary> List provisioned resources for a component with details. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentProvisionedResourceListCmdlet.ComponentName"> <summary> <para> <para>The name of the component whose provisioned resources you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentProvisionedResourceListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROComponentProvisionedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProvisionedResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListComponentProvisionedResourcesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListComponentProvisionedResourcesResponse 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.GetPROComponentProvisionedResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComponentName parameter. The -PassThru parameter is deprecated, use -Select '^ComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet"> <summary> Get detailed data for a deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.ComponentName"> <summary> <para> <para>The name of a component that you want to get the detailed data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.EnvironmentName"> <summary> <para> <para>The name of a environment that you want to get the detailed data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.Id"> <summary> <para> <para>The ID of the deployment that you want to get the detailed data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance associated with the given deployment ID. <c>serviceName</c> must be specified to identify the service instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.ServiceName"> <summary> <para> <para>The name of the service associated with the given deployment ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deployment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.GetDeploymentResponse 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.GetPRODeploymentCmdlet.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.GetPRODeploymentListCmdlet"> <summary> List deployments. You can filter the result list by environment, service, or a single service instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.ComponentName"> <summary> <para> <para>The name of a component for result list filtering. Proton returns deployments associated with that component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.EnvironmentName"> <summary> <para> <para>The name of an environment for result list filtering. Proton returns deployments associated with the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.ServiceName"> <summary> <para> <para>The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of deployments to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next deployment in the array of deployment, after the list of deployment that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRODeploymentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deployments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListDeploymentsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListDeploymentsResponse 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 detailed 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 detailed 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, get the detailed data for an environment account connection. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentAccountConnectionCmdlet.Id"> <summary> <para> <para>The ID of the environment account connection that you want to get the detailed data for.</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="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User 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 <c>ListEnvironmentAccountConnections</c> 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 that indicates 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 that indicates 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.GetPROEnvironmentOutputListCmdlet"> <summary> List the infrastructure as code outputs for your environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentOutputListCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment whose outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentOutputListCmdlet.EnvironmentName"> <summary> <para> <para>The environment name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentOutputListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentOutputListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Outputs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentOutputsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentOutputsResponse 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.GetPROEnvironmentOutputListCmdlet.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="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentProvisionedResourceListCmdlet"> <summary> List the provisioned resources for your environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentProvisionedResourceListCmdlet.EnvironmentName"> <summary> <para> <para>The environment name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentProvisionedResourceListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentProvisionedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProvisionedResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListEnvironmentProvisionedResourcesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListEnvironmentProvisionedResourcesResponse 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.GetPROEnvironmentProvisionedResourceListCmdlet.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="T:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateCmdlet"> <summary> Get detailed 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 detailed 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 that indicates 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> Get detailed 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 get environment template major version detail data, include <c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To get environment template minor version detail data, include <c>minorVersion</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROEnvironmentTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the environment template a version of which you want to get detailed data for.</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 <c>major Version</c>.</para><para>To view a list of major versions of an environment template, <i>exclude</i><c>major Version</c>.</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 that indicates 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.GetPRORepositoryCmdlet"> <summary> Get detail data for a linked repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryCmdlet.Name"> <summary> <para> <para>The repository name, for example <c>myrepos/myrepo</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryCmdlet.Provider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Repository'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetRepositoryResponse). Specifying the name of a property of type Amazon.Proton.Model.GetRepositoryResponse 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.GetPRORepositoryListCmdlet"> <summary> List linked repositories with detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of repositories to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositoryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Repositories'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListRepositoriesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListRepositoriesResponse 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.GetPRORepositorySyncDefinitionListCmdlet"> <summary> List repository sync definitions with detail data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncDefinitionListCmdlet.RepositoryName"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncDefinitionListCmdlet.RepositoryProvider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncDefinitionListCmdlet.SyncType"> <summary> <para> <para>The sync type. The only supported value is <c>TEMPLATE_SYNC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncDefinitionListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SyncDefinitions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListRepositorySyncDefinitionsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListRepositorySyncDefinitionsResponse 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.GetPRORepositorySyncStatusCmdlet"> <summary> Get the sync status of a repository used for Proton template sync. For more information about template sync, see . <note><para> A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC). </para><para> For more information about ABAC, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags">ABAC</a> in the <i>Proton User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncStatusCmdlet.Branch"> <summary> <para> <para>The repository branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncStatusCmdlet.RepositoryName"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncStatusCmdlet.RepositoryProvider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncStatusCmdlet.SyncType"> <summary> <para> <para>The repository sync type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPRORepositorySyncStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LatestSync'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetRepositorySyncStatusResponse). Specifying the name of a property of type Amazon.Proton.Model.GetRepositorySyncStatusResponse 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.GetPROResourcesSummaryCmdlet"> <summary> Get counts of Proton resources. <para> For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current. </para><para> The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the <c>components</c>, <c>environments</c>, and <c>serviceTemplates</c> field descriptions. </para><para> For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account. </para><para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html">Proton dashboard</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourcesSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Counts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetResourcesSummaryResponse). Specifying the name of a property of type Amazon.Proton.Model.GetResourcesSummaryResponse 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.GetPROResourceTagCmdlet"> <summary> List tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (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 that indicates 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 detailed 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 detailed 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 detailed data for a service instance. A service instance is an instantiation of service template and it runs 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 detailed data for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you want the service instance input for.</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 summary data. This action lists service instances of all services in the Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.Filter"> <summary> <para> <para>An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.</para> </para> </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.SortBy"> <summary> <para> <para>The field that the result list is sorted by.</para><para>When you choose to sort by <c>serviceName</c>, service instances within each service are sorted by service instance name.</para><para>Default: <c>serviceName</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceListCmdlet.SortOrder"> <summary> <para> <para>Result list sort order.</para><para>Default: <c>ASCENDING</c></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 that indicates 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.GetPROServiceInstanceOutputListCmdlet"> <summary> Get a list service of instance Infrastructure as Code (IaC) outputs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceOutputListCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment whose outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceOutputListCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance whose outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceOutputListCmdlet.ServiceName"> <summary> <para> <para>The name of the service that <c>serviceInstanceName</c> is associated to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceOutputListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceOutputListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Outputs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServiceInstanceOutputsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServiceInstanceOutputsResponse 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.GetPROServiceInstanceProvisionedResourceListCmdlet"> <summary> List provisioned resources for a service instance with details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceProvisionedResourceListCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance whose provisioned resources you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceProvisionedResourceListCmdlet.ServiceName"> <summary> <para> <para>The name of the service that <c>serviceInstanceName</c> is associated to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceProvisionedResourceListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceProvisionedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProvisionedResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServiceInstanceProvisionedResourcesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServiceInstanceProvisionedResourcesResponse 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.GetPROServiceInstanceSyncStatusCmdlet"> <summary> Get the status of the synced service instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceSyncStatusCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance that you want the sync status input for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceInstanceSyncStatusCmdlet.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.GetPROServiceInstanceSyncStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceInstanceSyncStatusResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceInstanceSyncStatusResponse 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.GetPROServiceInstanceSyncStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^ServiceInstanceName' 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 that indicates 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.GetPROServicePipelineOutputListCmdlet"> <summary> Get a list of service pipeline Infrastructure as Code (IaC) outputs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineOutputListCmdlet.DeploymentId"> <summary> <para> <para>The ID of the deployment you want the outputs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineOutputListCmdlet.ServiceName"> <summary> <para> <para>The name of the service whose pipeline's outputs you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineOutputListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineOutputListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Outputs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServicePipelineOutputsResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServicePipelineOutputsResponse 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.GetPROServicePipelineOutputListCmdlet.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.GetPROServicePipelineProvisionedResourceListCmdlet"> <summary> List provisioned resources for a service and pipeline with details. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineProvisionedResourceListCmdlet.ServiceName"> <summary> <para> <para>The name of the service whose pipeline's provisioned resources you want.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineProvisionedResourceListCmdlet.NextToken"> <summary> <para> <para>A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServicePipelineProvisionedResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProvisionedResources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.ListServicePipelineProvisionedResourcesResponse). Specifying the name of a property of type Amazon.Proton.Model.ListServicePipelineProvisionedResourcesResponse 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.GetPROServicePipelineProvisionedResourceListCmdlet.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.GetPROServiceSyncBlockerSummaryCmdlet"> <summary> Get detailed data for the service sync blocker summary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceSyncBlockerSummaryCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceSyncBlockerSummaryCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceSyncBlockerSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSyncBlockerSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceSyncBlockerSummaryResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceSyncBlockerSummaryResponse 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.GetPROServiceSyncBlockerSummaryCmdlet.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.GetPROServiceSyncConfigCmdlet"> <summary> Get detailed information for the service sync configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceSyncConfigCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you want to get the service sync configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetServiceSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.GetServiceSyncConfigResponse 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.GetPROServiceSyncConfigCmdlet.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.GetPROServiceTemplateCmdlet"> <summary> Get detailed 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 detailed 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 that indicates 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> Get detailed 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 get service template major version detail data, include <c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.MinorVersion"> <summary> <para> <para>To get service template minor version detail data, include <c>minorVersion</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROServiceTemplateVersionCmdlet.TemplateName"> <summary> <para> <para>The name of the service template a version of which you want to get detailed data for.</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 <c>major Version</c>.</para><para>To view a list of major versions of a service template, <i>exclude</i><c>major Version</c>.</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 that indicates 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.GetPROTemplateSyncConfigCmdlet"> <summary> Get detail data for a template sync configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncConfigCmdlet.TemplateName"> <summary> <para> <para>The template name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncConfigCmdlet.TemplateType"> <summary> <para> <para>The template type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetTemplateSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.GetTemplateSyncConfigResponse 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.GetPROTemplateSyncStatusCmdlet"> <summary> Get the status of a template sync. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncStatusCmdlet.TemplateName"> <summary> <para> <para>The template name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncStatusCmdlet.TemplateType"> <summary> <para> <para>The template type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncStatusCmdlet.TemplateVersion"> <summary> <para> <para>The template major version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.GetPROTemplateSyncStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.GetTemplateSyncStatusResponse). Specifying the name of a property of type Amazon.Proton.Model.GetTemplateSyncStatusResponse 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.NewPROComponentCmdlet"> <summary> Create an Proton component. A component is an infrastructure extension for a service instance. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.Description"> <summary> <para> <para>An optional customer-provided description of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.EnvironmentName"> <summary> <para> <para>The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify <c>serviceInstanceName</c> and <c>serviceName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.Manifest"> <summary> <para> <para>A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.Name"> <summary> <para> <para>The customer-provided name of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both <c>serviceInstanceName</c> and <c>serviceName</c> or neither of them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.ServiceName"> <summary> <para> <para>The name of the service that <c>serviceInstanceName</c> is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both <c>serviceInstanceName</c> and <c>serviceName</c> or neither of them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.ServiceSpec"> <summary> <para> <para>The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.TemplateFile"> <summary> <para> <para>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</para><note><para>Components support a single IaC file, even if you use Terraform as your template language.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.ClientToken"> <summary> <para> <para>The client token for the created component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateComponentResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateComponentResponse 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.NewPROComponentCmdlet.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.NewPROComponentCmdlet.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.NewPROEnvironmentCmdlet"> <summary> Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. <para><b>You can provision environments using the following methods:</b></para><ul><li><para> Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources. </para></li><li><para> Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.ProvisioningRepository_Branch"> <summary> <para> <para>The repository branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.CodebuildRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</para><para>To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the <c>environmentAccountConnectionId</c> or <c>codebuildRoleArn</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.ComponentRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</para><para>You must specify <c>componentRoleArn</c> to allow directly defined components to be associated with this environment.</para><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</para> </para> </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. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User guide</i>.</para><para>To use Amazon Web Services-managed provisioning for the environment, specify either the <c>environmentAccountConnectionId</c> or <c>protonServiceRoleArn</c> parameter and omit the <c>provisioningRepository</c> parameter.</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.ProvisioningRepository_Name"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.ProtonServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.</para><para>To use Amazon Web Services-managed provisioning for the environment, specify either the <c>environmentAccountConnectionId</c> or <c>protonServiceRoleArn</c> parameter and omit the <c>provisioningRepository</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.ProvisioningRepository_Provider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Spec"> <summary> <para> <para>A YAML formatted string 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/userguide/ag-environments.html">Environments</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.TemplateMajorVersion"> <summary> <para> <para>The major version of the environment template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentCmdlet.TemplateMinorVersion"> <summary> <para> <para>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/userguide/ag-templates.html">Environment Templates</a> in the <i>Proton User 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 a 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="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.CodebuildRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.ComponentRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.</para><para>You must specify <c>componentRoleArn</c> to allow directly defined components to be associated with any environments running in this account.</para><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.EnvironmentName"> <summary> <para> <para>The name of the 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 and manage the Proton environment in this account. If the management account accepts the environment account connection, 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. 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.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentAccountConnectionCmdlet.ClientToken"> <summary> <para> <para>When included, if two identical requests are made with the same client token, 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 Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Environment Templates</a> in the <i>Proton User 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 Proton to deploy and manage environment infrastructure. </para></li><li><para> Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the <c>provisioning</c> parameter and set the value to <c>CUSTOMER_MANAGED</c>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/template-create.html">Register and publish an environment template</a> in the <i>Proton User 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 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>An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</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 <c>major Version</c>.</para><para>To create a new major and minor version of the environment template, exclude <c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROEnvironmentTemplateVersionCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</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 identical requests are made with the same client token, 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.NewPRORepositoryCmdlet"> <summary> Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a <a href="https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html">service-linked role</a> for you. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a>, <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles">Template bundles</a>, and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.ConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html">Setting up for Proton</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.EncryptionKey"> <summary> <para> <para>The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.Name"> <summary> <para> <para>The repository name (for example, <c>myrepos/myrepo</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.Provider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPRORepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Repository'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateRepositoryResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateRepositoryResponse 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.NewPRORepositoryCmdlet.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.NewPRORepositoryCmdlet.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 Proton service. An 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/userguide/ag-services.html">Services</a> in the <i>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 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 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 Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an AWS CodeStar connection</a> in the <i>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. <i>Don’t</i> include pipeline inputs in the spec if your service template <i>doesn’t</i> include a service pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html">Create a service</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceCmdlet.TemplateMajorVersion"> <summary> <para> <para>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 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.NewPROServiceInstanceCmdlet"> <summary> Create a service instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.Name"> <summary> <para> <para>The name of the service instance to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.ServiceName"> <summary> <para> <para>The name of the service the service instance is added to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.Spec"> <summary> <para> <para>The spec for the service instance you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.TemplateMajorVersion"> <summary> <para> <para>To create a new major and minor version of the service template, <i>exclude</i><c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.TemplateMinorVersion"> <summary> <para> <para>To create a new minor version of the service template, include a <c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.ClientToken"> <summary> <para> <para>The client token of the service instance to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceInstanceCmdlet.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.CreateServiceInstanceResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateServiceInstanceResponse 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.NewPROServiceInstanceCmdlet.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.NewPROServiceInstanceCmdlet.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.NewPROServiceSyncConfigCmdlet"> <summary> Create the Proton Ops configuration file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.Branch"> <summary> <para> <para>The repository branch for your Proton Ops file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.FilePath"> <summary> <para> <para>The path to the Proton Ops file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.RepositoryName"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.RepositoryProvider"> <summary> <para> <para>The provider type for your repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.ServiceName"> <summary> <para> <para>The name of the service the Proton Ops file is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateServiceSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateServiceSyncConfigResponse 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.NewPROServiceSyncConfigCmdlet.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.NewPROServiceSyncConfigCmdlet.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 CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. 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/userguide/ag-templates.html">Proton templates</a> in the <i>Proton User 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>By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline <i>isn't</i> provided for your service. After it's included, it <i>can't</i> be changed. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles">Template bundles</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</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> backward compatible. A minor version of a service template is a version that's backward 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 environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.</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 <c>major Version</c>.</para><para>To create a new major and minor version of the service template, <i>exclude</i><c>major Version</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.SupportedComponentSource"> <summary> <para> <para>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</para><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROServiceTemplateVersionCmdlet.Tag"> <summary> <para> <para>An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.</para><para>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</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 identical requests are made with the same client token, 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.NewPROTemplateSyncConfigCmdlet"> <summary> Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>. <para> When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.Branch"> <summary> <para> <para>The repository branch for your template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.RepositoryName"> <summary> <para> <para>The repository name (for example, <c>myrepos/myrepo</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.RepositoryProvider"> <summary> <para> <para>The provider type for your repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.Subdirectory"> <summary> <para> <para>A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.TemplateName"> <summary> <para> <para>The name of your registered template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.TemplateType"> <summary> <para> <para>The type of the registered template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.NewPROTemplateSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CreateTemplateSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.CreateTemplateSyncConfigResponse 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.NewPROTemplateSyncConfigCmdlet.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.RemovePROComponentCmdlet"> <summary> Delete an Proton component resource. <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROComponentCmdlet.Name"> <summary> <para> <para>The name of the component to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteComponentResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteComponentResponse 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.RemovePROComponentCmdlet.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.RemovePROComponentCmdlet.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.RemovePRODeploymentCmdlet"> <summary> Delete the deployment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePRODeploymentCmdlet.Id"> <summary> <para> <para>The ID of the deployment to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePRODeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Deployment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteDeploymentResponse 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.RemovePRODeploymentCmdlet.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.RemovePRODeploymentCmdlet.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 Proton environment, 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="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User 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 <c>Recommended</c> version. Delete the <c>Recommended</c> 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 backward compatible. <para> Delete a minor version of an environment template if it <i>isn't</i> the <c>Recommended</c> version. Delete a <c>Recommended</c> 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 backward 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.RemovePRORepositoryCmdlet"> <summary> De-register and unlink your repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePRORepositoryCmdlet.Name"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePRORepositoryCmdlet.Provider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePRORepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Repository'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteRepositoryResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteRepositoryResponse 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.RemovePRORepositoryCmdlet.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.RemovePRORepositoryCmdlet.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 customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource. <para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to remove customer tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of customer tag keys that indicate the customer 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, with its instances and pipeline. <note><para> You can't delete a service if it has any service instances that have components attached to them. </para><para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para></note> </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.RemovePROServiceSyncConfigCmdlet"> <summary> Delete the Proton Ops file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceSyncConfigCmdlet.ServiceName"> <summary> <para> <para>The name of the service that you want to delete the service sync configuration for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROServiceSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteServiceSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteServiceSyncConfigResponse 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.RemovePROServiceSyncConfigCmdlet.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.RemovePROServiceSyncConfigCmdlet.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 <c>Recommended</c> version. Delete the <c>Recommended</c> 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 <c>Recommended</c> version. Delete a <c>Recommended</c> 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.RemovePROTemplateSyncConfigCmdlet"> <summary> Delete a template sync configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROTemplateSyncConfigCmdlet.TemplateName"> <summary> <para> <para>The template name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROTemplateSyncConfigCmdlet.TemplateType"> <summary> <para> <para>The template type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.RemovePROTemplateSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.DeleteTemplateSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.DeleteTemplateSyncConfigResponse 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.RemovePROTemplateSyncConfigCmdlet.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.StopPROComponentDeploymentCmdlet"> <summary> Attempts to cancel a component deployment (for a component that is in the <c>IN_PROGRESS</c> deployment status). <para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROComponentDeploymentCmdlet.ComponentName"> <summary> <para> <para>The name of the component with the deployment to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROComponentDeploymentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CancelComponentDeploymentResponse). Specifying the name of a property of type Amazon.Proton.Model.CancelComponentDeploymentResponse 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.StopPROComponentDeploymentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ComponentName parameter. The -PassThru parameter is deprecated, use -Select '^ComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.StopPROComponentDeploymentCmdlet.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 <c>IN_PROGRESS</c>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html">Update an environment</a> in the <i>Proton User guide</i>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <c>CANCELLED</c>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <c>FAILED</c>. </para></li><li><para> If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <c>SUCCEEDED</c> 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 <c>IN_PROGRESS</c>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html">Update a service instance</a> in the <i>Proton User guide</i>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <c>CANCELLED</c>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <c>FAILED</c>. </para></li><li><para> If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <c>SUCCEEDED</c> 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 <c>IN_PROGRESS</c>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html">Update a service pipeline</a> in the <i>Proton User guide</i>. <para> The following list includes potential cancellation scenarios. </para><ul><li><para> If the cancellation attempt succeeds, the resulting deployment state is <c>CANCELLED</c>. </para></li><li><para> If the cancellation attempt fails, the resulting deployment state is <c>FAILED</c>. </para></li><li><para> If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is <c>SUCCEEDED</c> 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 Proton settings that are used for multiple services in the Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineProvisioningRepository_Branch"> <summary> <para> <para>The repository branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.DeletePipelineProvisioningRepository"> <summary> <para> <para>Set to <c>true</c> to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineProvisioningRepository_Name"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineCodebuildRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.</para><para>To remove a previously configured ARN, specify an empty string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROAccountSettingCmdlet.PipelineProvisioningRepository_Provider"> <summary> <para> <para>The repository provider.</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.UpdatePROComponentCmdlet"> <summary> Update a component. <para> There are a few modes for updating a component. The <c>deploymentType</c> field defines the mode. </para><note><para> You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is <c>IN_PROGRESS</c>. </para></note><para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.DeploymentType"> <summary> <para> <para>The deployment type. It defines the mode for updating a component, as follows:</para><dl><dt /><dd><para><c>NONE</c></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. You can only specify <c>description</c> in this mode.</para></dd><dt /><dd><para><c>CURRENT_VERSION</c></para><para>In this mode, the component is deployed and updated with the new <c>serviceSpec</c>, <c>templateSource</c>, and/or <c>type</c> that you provide. Only requested parameters are updated.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.Description"> <summary> <para> <para>An optional customer-provided description of the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.Name"> <summary> <para> <para>The name of the component to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.ServiceInstanceName"> <summary> <para> <para>The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both <c>serviceInstanceName</c> and <c>serviceName</c> or for neither of them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.ServiceName"> <summary> <para> <para>The name of the service that <c>serviceInstanceName</c> is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both <c>serviceInstanceName</c> and <c>serviceName</c> or for neither of them.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.ServiceSpec"> <summary> <para> <para>The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.TemplateFile"> <summary> <para> <para>A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.</para><note><para>Components support a single IaC file, even if you use Terraform as your template language.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.ClientToken"> <summary> <para> <para>The client token for the updated component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Component'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateComponentResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateComponentResponse 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.UpdatePROComponentCmdlet.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.UpdatePROComponentCmdlet.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 <c>protonServiceRoleArn</c> and <c>provisioningRepository</c> parameter to update or connect to an environment account connection. </para><para> You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be 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 <c>environmentAccountConnectionId</c> parameter. You <i>can't</i> update or connect the environment to an environment account connection if it <i>isn't</i> already associated with an environment connection. </para><para> You can update either the <c>environmentAccountConnectionId</c> or <c>protonServiceRoleArn</c> parameter and value. You can’t update both. </para><para> If the environment was configured for Amazon Web Services-managed provisioning, omit the <c>provisioningRepository</c> parameter. </para><para> If the environment was configured for self-managed provisioning, specify the <c>provisioningRepository</c> parameter and omit the <c>protonServiceRoleArn</c> and <c>environmentAccountConnectionId</c> parameters. </para><para> For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton User Guide</i>. </para><para> There are four modes for updating an environment. The <c>deploymentType</c> field defines the mode. </para><dl><dt /><dd><para><c>NONE</c></para><para> In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. </para></dd><dt /><dd><para><c>CURRENT_VERSION</c></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 <c>deployment-type</c>. </para></dd><dt /><dd><para><c>MINOR_VERSION</c></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><c>MAJOR_VERSION</c></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. </para></dd></dl> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.ProvisioningRepository_Branch"> <summary> <para> <para>The repository branch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.CodebuildRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.ComponentRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</para><para>The environment must have a <c>componentRoleArn</c> to allow directly defined components to be associated with the environment.</para><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.DeploymentType"> <summary> <para> <para>There are four modes for updating an environment. The <c>deploymentType</c> field defines the mode.</para><dl><dt /><dd><para><c>NONE</c></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><c>CURRENT_VERSION</c></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 major or minor version parameters when you use this <c>deployment-type</c>.</para></dd><dt /><dd><para><c>MINOR_VERSION</c></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><c>MAJOR_VERSION</c></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 is 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.ProvisioningRepository_Name"> <summary> <para> <para>The repository name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.ProtonServiceRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.ProvisioningRepository_Provider"> <summary> <para> <para>The repository provider.</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 major version of the environment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentCmdlet.TemplateMinorVersion"> <summary> <para> <para>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="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.CodebuildRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROEnvironmentAccountConnectionCmdlet.ComponentRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.</para><para>The environment account connection must have a <c>componentRoleArn</c> to allow directly defined components to be associated with any environments running in the account.</para><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</para> </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's 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 <c>major Version</c>.</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 <c>minorVersion</c>.</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 <c>description</c> parameter to modify the description. </para><para> Edit the <c>spec</c> parameter to add or delete instances. </para><note><para> You can't delete a service instance (remove it from the spec) if it has an attached component. </para><para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para></note> </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 <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-update.html">Edit a service</a> in the <i>Proton User Guide</i>.</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 a few modes for updating a service instance. The <c>deploymentType</c> field defines the mode. </para><note><para> You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is <c>IN_PROGRESS</c>. </para><para> For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceInstanceCmdlet.DeploymentType"> <summary> <para> <para>The deployment type. It defines the mode for updating a service instance, as follows:</para><dl><dt /><dd><para><c>NONE</c></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><c>CURRENT_VERSION</c></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 major or minor version parameters when you use this deployment type.</para></dd><dt /><dd><para><c>MINOR_VERSION</c></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><c>MAJOR_VERSION</c></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 specify a different major version that's higher than the major version in use and a minor version.</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.ClientToken"> <summary> <para> <para>The client token of the service instance 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. The <c>deploymentType</c> field defines the mode. </para><dl><dt /><dd><para><c>NONE</c></para><para> In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated. </para></dd><dt /><dd><para><c>CURRENT_VERSION</c></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 major or minor version parameters when you use this <c>deployment-type</c>. </para></dd><dt /><dd><para><c>MINOR_VERSION</c></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 specify a different minor version of the current major version in use. </para></dd><dt /><dd><para><c>MAJOR_VERSION</c></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 specify a different major version that's higher than the major version in use and a minor version. </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. The <c>deploymentType</c> field defines the mode.</para><dl><dt /><dd><para><c>NONE</c></para><para>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</para></dd><dt /><dd><para><c>CURRENT_VERSION</c></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 major or minor version parameters when you use this <c>deployment-type</c>.</para></dd><dt /><dd><para><c>MINOR_VERSION</c></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 specify a different minor version of the current major version in use.</para></dd><dt /><dd><para><c>MAJOR_VERSION</c></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 specify a different major version that's higher than the major version in use and a minor version.</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.UpdatePROServiceSyncBlockerCmdlet"> <summary> Update the service sync blocker by resolving it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncBlockerCmdlet.Id"> <summary> <para> <para>The ID of the service sync blocker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncBlockerCmdlet.ResolvedReason"> <summary> <para> <para>The reason the service sync blocker was resolved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncBlockerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServiceSyncBlockerResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServiceSyncBlockerResponse 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.UpdatePROServiceSyncBlockerCmdlet.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.UpdatePROServiceSyncConfigCmdlet"> <summary> Update the Proton Ops config file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.Branch"> <summary> <para> <para>The name of the code repository branch where the Proton Ops file is found.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.FilePath"> <summary> <para> <para>The path to the Proton Ops file.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.RepositoryName"> <summary> <para> <para>The name of the repository where the Proton Ops file is found.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.RepositoryProvider"> <summary> <para> <para>The name of the repository provider where the Proton Ops file is found.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.ServiceName"> <summary> <para> <para>The name of the service the Proton Ops file is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROServiceSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ServiceSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateServiceSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateServiceSyncConfigResponse 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.UpdatePROServiceSyncConfigCmdlet.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 that's 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 environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.</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 <c>major Version</c>.</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 <c>minorVersion</c>.</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.SupportedComponentSource"> <summary> <para> <para>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</para><note><para>A change to <c>supportedComponentSources</c> doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.</para></note><para>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</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> <member name="T:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet"> <summary> Update template sync configuration parameters, except for the <c>templateName</c> and <c>templateType</c>. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.Branch"> <summary> <para> <para>The repository branch for your template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.RepositoryName"> <summary> <para> <para>The repository name (for example, <c>myrepos/myrepo</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.RepositoryProvider"> <summary> <para> <para>The repository provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.Subdirectory"> <summary> <para> <para>A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.TemplateName"> <summary> <para> <para>The synced template name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.TemplateType"> <summary> <para> <para>The synced template type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PRO.UpdatePROTemplateSyncConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateSyncConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.UpdateTemplateSyncConfigResponse). Specifying the name of a property of type Amazon.Proton.Model.UpdateTemplateSyncConfigResponse 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.UpdatePROTemplateSyncConfigCmdlet.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> |