Class CreateResourceConfigurationRequest

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

  • Method Details

    • allowAssociationToShareableServiceNetwork

      public final Boolean allowAssociationToShareableServiceNetwork()

      (SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.

      Returns:
      (SINGLE, GROUP, ARN) Specifies whether the resource configuration can be associated with a sharable service network. The default is false.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

    • name

      public final String name()

      The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

      Returns:
      The name of the resource configuration. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

    • hasPortRanges

      public final boolean hasPortRanges()
      For responses, this returns true if the service returned a value for the PortRanges 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.

    • portRanges

      public final List<String> portRanges()

      (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).

      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 hasPortRanges() method.

      Returns:
      (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535). You can separate port ranges using commas (for example: 1,2,22-30).

    • protocol

      public final ProtocolType protocol()

      (SINGLE, GROUP) The protocol accepted by the resource configuration.

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

      Returns:
      (SINGLE, GROUP) The protocol accepted by the resource configuration.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      (SINGLE, GROUP) The protocol accepted by the resource configuration.

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

      Returns:
      (SINGLE, GROUP) The protocol accepted by the resource configuration.
      See Also:

    • resourceConfigurationDefinition

      public final ResourceConfigurationDefinition resourceConfigurationDefinition()

      (SINGLE, CHILD, ARN) The resource configuration.

      Returns:
      (SINGLE, CHILD, ARN) The resource configuration.

    • resourceConfigurationGroupIdentifier

      public final String resourceConfigurationGroupIdentifier()

      (CHILD) The ID or ARN of the parent resource configuration (type is GROUP). This is used to associate a child resource configuration with a group resource configuration.

      Returns:
      (CHILD) The ID or ARN of the parent resource configuration (type is GROUP). This is used to associate a child resource configuration with a group resource configuration.

    • resourceGatewayIdentifier

      public final String resourceGatewayIdentifier()

      (SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.

      Returns:
      (SINGLE, GROUP, ARN) The ID or ARN of the resource gateway used to connect to the resource configuration. For a child resource configuration, this value is inherited from the parent resource configuration.

    • 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 for the resource configuration.

      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 for the resource configuration.

    • type

      public final ResourceConfigurationType type()

      The type of resource configuration.

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

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

      Returns:
      The type of resource configuration.

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of resource configuration.

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

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

      Returns:
      The type of resource configuration.

      • SINGLE - A single resource.

      • GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.

      • CHILD - A single resource that is part of a group resource configuration.

      • ARN - An Amazon Web Services resource.

      See Also:

    • toBuilder

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

    • builder

      public static CreateResourceConfigurationRequest.Builder builder()

    • serializableBuilderClass

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