Interface SsmDocumentConfig.Builder

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

  • Method Details

    • crossAccountRole

      SsmDocumentConfig.Builder crossAccountRole(String crossAccountRole)

      The cross-account role for the configuration.

      Parameters:
      crossAccountRole - The cross-account role for the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • externalId

      SsmDocumentConfig.Builder externalId(String externalId)

      The external ID (secret key) for the configuration.

      Parameters:
      externalId - The external ID (secret key) for the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentArn

      SsmDocumentConfig.Builder documentArn(String documentArn)

      The Amazon Resource Name (ARN) of the Systems Manager document to run.

      Parameters:
      documentArn - The Amazon Resource Name (ARN) of the Systems Manager document to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      SsmDocumentConfig.Builder targets(Collection<SsmTarget> targets)

      The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

      Parameters:
      targets - The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      SsmDocumentConfig.Builder targets(SsmTarget... targets)

      The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

      Parameters:
      targets - The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targets

      SsmDocumentConfig.Builder targets(Consumer<SsmTarget.Builder>... targets)

      The target filters that Systems Manager resolves to managed nodes when the command runs. To target specific managed nodes, use the InstanceIds key. You can specify up to five target filters.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targets(List<SsmTarget>).

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

    • parameters

      SsmDocumentConfig.Builder parameters(Map<String,? extends Collection<String>> parameters)

      The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.

      Parameters:
      parameters - The parameters that are passed to this Region's Systems Manager document. You set parameters for each document, so each Region can run its document with its own parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentVersion

      SsmDocumentConfig.Builder documentVersion(String documentVersion)

      The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.

      Parameters:
      documentVersion - The version of the Systems Manager document to run for this Region. When you omit it, Systems Manager runs the document's default version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.