Interface Service.Builder

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

  • Method Details

    • keyAttributes

      Service.Builder keyAttributes(Map<String,String> keyAttributes)

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      Parameters:
      keyAttributes - This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

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

    • attributeMaps

      Service.Builder attributeMaps(Collection<? extends Map<String,String>> attributeMaps)

      This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

      Platform attributes contain information the service's platform.

      • PlatformType defines the hosted-in platform.

      • EKS.Cluster is the name of the Amazon EKS cluster.

      • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

      • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

      • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

      • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

      • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

      • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

      • EC2.InstanceId is the ID of the Amazon EC2 instance.

      • Host is the name of the host, for all platform types.

      Application attributes contain information about the application.

      • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

      • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

      Telemetry attributes contain telemetry information.

      • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

      • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

      • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

      Parameters:
      attributeMaps - This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

      Platform attributes contain information the service's platform.

      • PlatformType defines the hosted-in platform.

      • EKS.Cluster is the name of the Amazon EKS cluster.

      • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

      • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

      • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

      • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

      • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

      • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

      • EC2.InstanceId is the ID of the Amazon EC2 instance.

      • Host is the name of the host, for all platform types.

      Application attributes contain information about the application.

      • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

      • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

      Telemetry attributes contain telemetry information.

      • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

      • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

      • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

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

    • attributeMaps

      Service.Builder attributeMaps(Map<String,String>... attributeMaps)

      This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

      Platform attributes contain information the service's platform.

      • PlatformType defines the hosted-in platform.

      • EKS.Cluster is the name of the Amazon EKS cluster.

      • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

      • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

      • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

      • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

      • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

      • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

      • EC2.InstanceId is the ID of the Amazon EC2 instance.

      • Host is the name of the host, for all platform types.

      Application attributes contain information about the application.

      • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

      • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

      Telemetry attributes contain telemetry information.

      • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

      • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

      • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

      Parameters:
      attributeMaps - This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

      Platform attributes contain information the service's platform.

      • PlatformType defines the hosted-in platform.

      • EKS.Cluster is the name of the Amazon EKS cluster.

      • K8s.Cluster is the name of the self-hosted Kubernetes cluster.

      • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

      • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

      • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

      • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

      • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

      • EC2.InstanceId is the ID of the Amazon EC2 instance.

      • Host is the name of the host, for all platform types.

      Application attributes contain information about the application.

      • AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

      • AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

      Telemetry attributes contain telemetry information.

      • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

      • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

      • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

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

    • metricReferences

      Service.Builder metricReferences(Collection<MetricReference> metricReferences)

      An array of structures that each contain information about one metric associated with this service.

      Parameters:
      metricReferences - An array of structures that each contain information about one metric associated with this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricReferences

      Service.Builder metricReferences(MetricReference... metricReferences)

      An array of structures that each contain information about one metric associated with this service.

      Parameters:
      metricReferences - An array of structures that each contain information about one metric associated with this service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricReferences

      Service.Builder metricReferences(Consumer<MetricReference.Builder>... metricReferences)

      An array of structures that each contain information about one metric associated with this service.

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

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

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

    • logGroupReferences

      Service.Builder logGroupReferences(Collection<? extends Map<String,String>> logGroupReferences)

      An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

      • "Type": "AWS::Resource"

      • "ResourceType": "AWS::Logs::LogGroup"

      • "Identifier": "name-of-log-group"

      Parameters:
      logGroupReferences - An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

      • "Type": "AWS::Resource"

      • "ResourceType": "AWS::Logs::LogGroup"

      • "Identifier": "name-of-log-group"

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

    • logGroupReferences

      Service.Builder logGroupReferences(Map<String,String>... logGroupReferences)

      An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

      • "Type": "AWS::Resource"

      • "ResourceType": "AWS::Logs::LogGroup"

      • "Identifier": "name-of-log-group"

      Parameters:
      logGroupReferences - An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

      • "Type": "AWS::Resource"

      • "ResourceType": "AWS::Logs::LogGroup"

      • "Identifier": "name-of-log-group"

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