AWS.Tools.SimSpaceWeaver.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SimSpaceWeaver</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet"> <summary> Adds tags to a SimSpace Weaver resource. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to add tags to. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.AddSSWResourceTagCmdlet.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.SSW.GetSSWAppCmdlet"> <summary> Returns the state of the given custom app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppCmdlet.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.SimSpaceWeaver.Model.DescribeAppResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.DescribeAppResponse 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.SSW.GetSSWAppListCmdlet"> <summary> Lists all custom apps or service apps for the given simulation and domain.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Domain"> <summary> <para> <para>The name of the domain that you want to list apps for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Simulation"> <summary> <para> <para>The name of the simulation that you want to list apps for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of apps to list.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.NextToken"> <summary> <para> <para>If SimSpace Weaver returns <c>nextToken</c>, then there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <c>nextToken</c> is set to <c>null</c>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Apps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimSpaceWeaver.Model.ListAppsResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListAppsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWAppListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet"> <summary> Lists all tags on a SimSpace Weaver resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet"> <summary> Returns the current state of the given simulation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationCmdlet.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.SimSpaceWeaver.Model.DescribeSimulationResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.DescribeSimulationResponse 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.SSW.GetSSWSimulationListCmdlet"> <summary> Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of simulations to list.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.NextToken"> <summary> <para> <para>If SimSpace Weaver returns <c>nextToken</c>, then there are more results available. The value of <c>nextToken</c> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <c>nextToken</c> is set to <c>null</c>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.GetSSWSimulationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Simulations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimSpaceWeaver.Model.ListSimulationsResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.ListSimulationsResponse 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.SSW.GetSSWSimulationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet"> <summary> Creates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>. <para> You specify a <c>Destination</c> when you create a snapshot. The <c>Destination</c> is the name of an Amazon S3 bucket and an optional <c>ObjectKeyPrefix</c>. The <c>ObjectKeyPrefix</c> is usually the name of a folder in the bucket. SimSpace Weaver creates a <c>snapshot</c> folder inside the <c>Destination</c> and places the snapshot file there. </para><para> The snapshot file is an Amazon S3 object. It has an object key with the form: <c><i>object-key-prefix</i>/snapshot/<i>simulation-name</i>-<i>YYMMdd</i>-<i>HHmm</i>-<i>ss</i>.zip</c>, where: </para><ul><li><para><c><i>YY</i></c> is the 2-digit year </para></li><li><para><c><i>MM</i></c> is the 2-digit month </para></li><li><para><c><i>dd</i></c> is the 2-digit day of the month </para></li><li><para><c><i>HH</i></c> is the 2-digit hour (24-hour clock) </para></li><li><para><c><i>mm</i></c> is the 2-digit minutes </para></li><li><para><c><i>ss</i></c> is the 2-digit seconds </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Destination_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Destination_ObjectKeyPrefix"> <summary> <para> <para>A string prefix for an Amazon S3 object key. It's usually a folder name. For more information about folders in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html">Organizing objects in the Amazon S3 console using folders</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.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.SimSpaceWeaver.Model.CreateSnapshotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.NewSSWSnapshotCmdlet.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.SSW.RemoveSSWAppCmdlet"> <summary> Deletes the instance of the given custom app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.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.SimSpaceWeaver.Model.DeleteAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWAppCmdlet.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.SSW.RemoveSSWResourceTagCmdlet"> <summary> Removes tags from a SimSpace Weaver resource. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to remove tags from. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys to remove from the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.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.SimSpaceWeaver.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWResourceTagCmdlet.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.SSW.RemoveSSWSimulationCmdlet"> <summary> Deletes all SimSpace Weaver resources assigned to the given simulation. <note><para> Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.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.SimSpaceWeaver.Model.DeleteSimulationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.RemoveSSWSimulationCmdlet.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.SSW.StartSSWAppCmdlet"> <summary> Starts a custom app with the configuration specified in the simulation schema. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Description"> <summary> <para> <para>The description of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.LaunchOverrides_LaunchCommand"> <summary> <para> <para>App launch commands and command line parameters that override the launch command configured in the simulation schema.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Name"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.ClientToken"> <summary> <para> <para>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <c>ClientToken</c> is also known as an <i>idempotency token</i>. A <c>ClientToken</c> expires after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWAppCmdlet.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.SimSpaceWeaver.Model.StartAppResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.StartAppResponse 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.SSW.StartSSWAppCmdlet.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.SSW.StartSSWClockCmdlet"> <summary> Starts the simulation clock. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.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.SimSpaceWeaver.Model.StartClockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWClockCmdlet.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.SSW.StartSSWSimulationCmdlet"> <summary> Starts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html">schema reference</a> in the <i>SimSpace Weaver User Guide</i>. For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a> in the <i>SimSpace Weaver User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SchemaS3Location_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SnapshotS3Location_BucketName"> <summary> <para> <para>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating, configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Description"> <summary> <para> <para>The description of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.MaximumDuration"> <summary> <para> <para>The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches this limit. The maximum value is <c>14D</c>, or its equivalent in the other units. The default value is <c>14D</c>. A value equivalent to <c>0</c> makes the simulation immediately transition to <c>Stopping</c> as soon as it reaches <c>Started</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Name"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SchemaS3Location_ObjectKey"> <summary> <para> <para>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading, downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.SnapshotS3Location_ObjectKey"> <summary> <para> <para>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading, downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the <i>Identity and Access Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.Tag"> <summary> <para> <para>A list of tags for the simulation. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.ClientToken"> <summary> <para> <para>A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A <c>ClientToken</c> is also known as an <i>idempotency token</i>. A <c>ClientToken</c> expires after 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StartSSWSimulationCmdlet.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.SimSpaceWeaver.Model.StartSimulationResponse). Specifying the name of a property of type Amazon.SimSpaceWeaver.Model.StartSimulationResponse 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.SSW.StartSSWSimulationCmdlet.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.SSW.StopSSWAppCmdlet"> <summary> Stops the given custom app and shuts down all of its allocated compute resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.App"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.Domain"> <summary> <para> <para>The name of the domain of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.Simulation"> <summary> <para> <para>The name of the simulation of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.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.SimSpaceWeaver.Model.StopAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWAppCmdlet.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.SSW.StopSSWClockCmdlet"> <summary> Stops the simulation clock. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.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.SimSpaceWeaver.Model.StopClockResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWClockCmdlet.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.SSW.StopSSWSimulationCmdlet"> <summary> Stops the given simulation. <important><para> You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.Simulation"> <summary> <para> <para>The name of the simulation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.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.SimSpaceWeaver.Model.StopSimulationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SSW.StopSSWSimulationCmdlet.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> |