Class CreateStudioComponentRequest

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

  • Method Details

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

    • configuration

      public final StudioComponentConfiguration configuration()

      The configuration of the studio component, based on component type.

      Returns:
      The configuration of the studio component, based on component type.

    • description

      public final String description()

      The description.

      Returns:
      The description.

    • hasEc2SecurityGroupIds

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

    • ec2SecurityGroupIds

      public final List<String> ec2SecurityGroupIds()

      The EC2 security groups that control access to the studio component.

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

      Returns:
      The EC2 security groups that control access to the studio component.

    • hasInitializationScripts

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

    • initializationScripts

      public final List<StudioComponentInitializationScript> initializationScripts()

      Initialization scripts for studio components.

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

      Returns:
      Initialization scripts for studio components.

    • name

      public final String name()

      The name for the studio component.

      Returns:
      The name for the studio component.

    • runtimeRoleArn

      public final String runtimeRoleArn()

      An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

      Returns:
      An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

    • hasScriptParameters

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

    • scriptParameters

      public final List<ScriptParameterKeyValue> scriptParameters()

      Parameters for the studio component scripts.

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

      Returns:
      Parameters for the studio component scripts.

    • secureInitializationRoleArn

      public final String secureInitializationRoleArn()

      An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

      Returns:
      An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

    • studioId

      public final String studioId()

      The studio ID.

      Returns:
      The studio ID.

    • subtype

      public final StudioComponentSubtype subtype()

      The specific subtype of a studio component.

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

      Returns:
      The specific subtype of a studio component.
      See Also:

    • subtypeAsString

      public final String subtypeAsString()

      The specific subtype of a studio component.

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

      Returns:
      The specific subtype of a studio component.
      See Also:

    • 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()

      A collection of labels, in the form of key-value pairs, that apply to this resource.

      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:
      A collection of labels, in the form of key-value pairs, that apply to this resource.

    • type

      public final StudioComponentType type()

      The type of the studio component.

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

      Returns:
      The type of the studio component.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the studio component.

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

      Returns:
      The type of the studio component.
      See Also:

    • toBuilder

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

    • builder

      public static CreateStudioComponentRequest.Builder builder()

    • serializableBuilderClass

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