Interface CreateActivationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>, SdkBuilder<CreateActivationRequest.Builder,CreateActivationRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
CreateActivationRequest
public static interface CreateActivationRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateActivationRequest.Builder,CreateActivationRequest>

  • Method Details

    • description

      CreateActivationRequest.Builder description(String description)

      A user-defined description of the resource that you want to register with Systems Manager.

      Don't enter personally identifiable information in this field.

      Parameters:
      description - A user-defined description of the resource that you want to register with Systems Manager.

      Don't enter personally identifiable information in this field.

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

    • defaultInstanceName

      CreateActivationRequest.Builder defaultInstanceName(String defaultInstanceName)

      The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

      Don't enter personally identifiable information in this field.

      Parameters:
      defaultInstanceName - The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

      Don't enter personally identifiable information in this field.

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

    • iamRole

      CreateActivationRequest.Builder iamRole(String iamRole)

      The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in a hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

      You can't specify an IAM service-linked role for this parameter. You must create a unique role.

      Parameters:
      iamRole - The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create the IAM service role required for Systems Manager in a hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

      You can't specify an IAM service-linked role for this parameter. You must create a unique role.

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

    • registrationLimit

      CreateActivationRequest.Builder registrationLimit(Integer registrationLimit)

      Specify the maximum number of managed nodes you want to register. The default value is 1.

      Parameters:
      registrationLimit - Specify the maximum number of managed nodes you want to register. The default value is 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expirationDate

      CreateActivationRequest.Builder expirationDate(Instant expirationDate)

      The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

      Parameters:
      expirationDate - The date by which this activation request should expire, in timestamp format, such as "2024-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateActivationRequest.Builder tags(Collection<Tag> tags)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

      Parameters:
      tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

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

    • tags

      CreateActivationRequest.Builder tags(Tag... tags)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

      Parameters:
      tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

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

    • tags

      CreateActivationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

      • Key=OS,Value=Windows

      • Key=Environment,Value=Production

      When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

      You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

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

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

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

    • registrationMetadata

      CreateActivationRequest.Builder registrationMetadata(Collection<RegistrationMetadataItem> registrationMetadata)

      Reserved for internal use.

      Parameters:
      registrationMetadata - Reserved for internal use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationMetadata

      CreateActivationRequest.Builder registrationMetadata(RegistrationMetadataItem... registrationMetadata)

      Reserved for internal use.

      Parameters:
      registrationMetadata - Reserved for internal use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • registrationMetadata

      CreateActivationRequest.Builder registrationMetadata(Consumer<RegistrationMetadataItem.Builder>... registrationMetadata)

      Reserved for internal use.

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

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

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

    • overrideConfiguration

      CreateActivationRequest.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

      CreateActivationRequest.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.