Package software.amazon.awssdk.services.xray.model

Interface TagResourceRequest.Builder

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

  • Method Details

    • resourceARN

      TagResourceRequest.Builder resourceARN(String resourceARN)

      The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

      Parameters:
      resourceARN - The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      TagResourceRequest.Builder tags(Collection<Tag> tags)

      A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      The following restrictions apply to tags:

      • Maximum number of user-applied tags per resource: 50

      • Maximum tag key length: 128 Unicode characters

      • Maximum tag value length: 256 Unicode characters

      • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

      • Tag keys and values are case sensitive.

      • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

      Parameters:
      tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      The following restrictions apply to tags:

      • Maximum number of user-applied tags per resource: 50

      • Maximum tag key length: 128 Unicode characters

      • Maximum tag value length: 256 Unicode characters

      • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

      • Tag keys and values are case sensitive.

      • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

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

    • tags

      TagResourceRequest.Builder tags(Tag... tags)

      A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      The following restrictions apply to tags:

      • Maximum number of user-applied tags per resource: 50

      • Maximum tag key length: 128 Unicode characters

      • Maximum tag value length: 256 Unicode characters

      • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

      • Tag keys and values are case sensitive.

      • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

      Parameters:
      tags - A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      The following restrictions apply to tags:

      • Maximum number of user-applied tags per resource: 50

      • Maximum tag key length: 128 Unicode characters

      • Maximum tag value length: 256 Unicode characters

      • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

      • Tag keys and values are case sensitive.

      • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

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

    • tags

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

      A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

      The following restrictions apply to tags:

      • Maximum number of user-applied tags per resource: 50

      • Maximum tag key length: 128 Unicode characters

      • Maximum tag value length: 256 Unicode characters

      • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

      • Tag keys and values are case sensitive.

      • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.

      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:

    • overrideConfiguration

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

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