Class CreateConnectionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest
software.amazon.awssdk.services.eventbridge.model.CreateConnectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateConnectionRequest extends EventBridgeRequest implements ToCopyableBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>

  • Method Details

    • name

      public final String name()

      The name for the connection to create.

      Returns:
      The name for the connection to create.

    • description

      public final String description()

      A description for the connection to create.

      Returns:
      A description for the connection to create.

    • authorizationType

      public final ConnectionAuthorizationType authorizationType()

      The type of authorization to use for the connection.

      OAUTH tokens are refreshed when a 401 or 407 response is returned.

      If the service returns an enum value that is not available in the current SDK version, authorizationType will return ConnectionAuthorizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationTypeAsString().

      Returns:
      The type of authorization to use for the connection.

      OAUTH tokens are refreshed when a 401 or 407 response is returned.

      See Also:

    • authorizationTypeAsString

      public final String authorizationTypeAsString()

      The type of authorization to use for the connection.

      OAUTH tokens are refreshed when a 401 or 407 response is returned.

      If the service returns an enum value that is not available in the current SDK version, authorizationType will return ConnectionAuthorizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationTypeAsString().

      Returns:
      The type of authorization to use for the connection.

      OAUTH tokens are refreshed when a 401 or 407 response is returned.

      See Also:

    • authParameters

      public final CreateConnectionAuthRequestParameters authParameters()

      The authorization parameters to use to authorize with the endpoint.

      You must include only authorization parameters for the AuthorizationType you specify.

      Returns:
      The authorization parameters to use to authorize with the endpoint.

      You must include only authorization parameters for the AuthorizationType you specify.

    • invocationConnectivityParameters

      public final ConnectivityResourceParameters invocationConnectivityParameters()

      For connections to private APIs, the parameters to use for invoking the API.

      For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

      Returns:
      For connections to private APIs, the parameters to use for invoking the API.

      For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

      If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.

      For more information, see Identify and view keys in the Key Management Service Developer Guide.

      Returns:
      The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

      If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the connection.

      For more information, see Identify and view keys in the Key Management Service Developer Guide.

    • toBuilder

      public CreateConnectionRequest.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<CreateConnectionRequest.Builder,CreateConnectionRequest>
      Specified by:
      toBuilder in class EventBridgeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateConnectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateConnectionRequest.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.