Class CreateConnectorRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>

@Generated("software.amazon.awssdk:codegen") public final class CreateConnectorRequest extends ObservabilityAdminRequest implements ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
  • Method Details

    • connectorConfiguration

      public final ConnectorConfiguration connectorConfiguration()

      The configuration for connecting to the third-party cloud provider.

      Returns:
      The configuration for connecting to the third-party cloud provider.
    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal, observabilityadmin.amazonaws.com. The role must also allow sts:GetWebIdentityToken for the provider's token exchange audience.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal, observabilityadmin.amazonaws.com. The role must also allow sts:GetWebIdentityToken for the provider's token exchange audience.
    • name

      public final String name()

      The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a ConflictException.

      The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.

      Returns:
      The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a ConflictException.

      The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • tags

      public final Map<String,String> tags()

      The tags that you want to apply to the connector.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags that you want to apply to the connector.
    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a ValidationException. This operation is idempotent when you use the same token and parameters.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a ValidationException. This operation is idempotent when you use the same token and parameters.
    • toBuilder

      public CreateConnectorRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateConnectorRequest.Builder,CreateConnectorRequest>
      Specified by:
      toBuilder in class ObservabilityAdminRequest
      Returns:
      a builder for type T
    • builder

      public static CreateConnectorRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends CreateConnectorRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.