Package software.amazon.awssdk.services.eventbridge.model

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()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateConnectionRequest.Builder,CreateConnectionRequest>
      Specified by:
      toBuilder in class EventBridgeRequest

    • 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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo