Interface StartSimulationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartSimulationRequest.Builder,StartSimulationRequest>, SdkBuilder<StartSimulationRequest.Builder,StartSimulationRequest>, SdkPojo, SdkRequest.Builder, SimSpaceWeaverRequest.Builder
Enclosing class:
StartSimulationRequest
@Mutable @NotThreadSafe public static interface StartSimulationRequest.Builder extends SimSpaceWeaverRequest.Builder, SdkPojo, CopyableBuilder<StartSimulationRequest.Builder,StartSimulationRequest>

  • Method Details

    • clientToken

      StartSimulationRequest.Builder clientToken(String clientToken)

      A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.

      Parameters:
      clientToken - A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once. A ClientToken is also known as an idempotency token. A ClientToken expires after 24 hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartSimulationRequest.Builder description(String description)

      The description of the simulation.

      Parameters:
      description - The description of the simulation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumDuration

      StartSimulationRequest.Builder maximumDuration(String maximumDuration)

      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 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.

      Parameters:
      maximumDuration - 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 14D, or its equivalent in the other units. The default value is 14D. A value equivalent to 0 makes the simulation immediately transition to Stopping as soon as it reaches Started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartSimulationRequest.Builder name(String name)

      The name of the simulation.

      Parameters:
      name - The name of the simulation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      StartSimulationRequest.Builder roleArn(String roleArn)

      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 Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.

      Parameters:
      roleArn - 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 Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access Management User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaS3Location

      StartSimulationRequest.Builder schemaS3Location(S3Location schemaS3Location)

      The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SchemaS3Location to start your simulation from a schema.

      If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

      Parameters:
      schemaS3Location - The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SchemaS3Location to start your simulation from a schema.

      If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaS3Location

      default StartSimulationRequest.Builder schemaS3Location(Consumer<S3Location.Builder> schemaS3Location)

      The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SchemaS3Location to start your simulation from a schema.

      If you provide a SchemaS3Location then you can't provide a SnapshotS3Location.

      This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schemaS3Location(S3Location).

      Parameters:
      schemaS3Location - a consumer that will call methods on S3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • snapshotS3Location

      StartSimulationRequest.Builder snapshotS3Location(S3Location snapshotS3Location)

      The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SnapshotS3Location to start your simulation from a snapshot.

      The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

      If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

      Parameters:
      snapshotS3Location - The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SnapshotS3Location to start your simulation from a snapshot.

      The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

      If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotS3Location

      default StartSimulationRequest.Builder snapshotS3Location(Consumer<S3Location.Builder> snapshotS3Location)

      The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about Amazon S3, see the Amazon Simple Storage Service User Guide .

      Provide a SnapshotS3Location to start your simulation from a snapshot.

      The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.

      If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.

      This is a convenience method that creates an instance of the S3Location.Builder avoiding the need to create one manually via S3Location.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snapshotS3Location(S3Location).

      Parameters:
      snapshotS3Location - a consumer that will call methods on S3Location.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      StartSimulationRequest.Builder tags(Map<String,String> tags)

      A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      Parameters:
      tags - A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartSimulationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSimulationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.