Class CreateProfileRequest

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

  • Method Details

    • acceptRoleSessionName

      public final Boolean acceptRoleSessionName()

      Used to determine if a custom role session name will be accepted in a temporary credential request.

      Returns:
      Used to determine if a custom role session name will be accepted in a temporary credential request.

    • durationSeconds

      public final Integer durationSeconds()

      Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      Returns:
      Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

    • enabled

      public final Boolean enabled()

      Specifies whether the profile is enabled.

      Returns:
      Specifies whether the profile is enabled.

    • hasManagedPolicyArns

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

    • managedPolicyArns

      public final List<String> managedPolicyArns()

      A list of managed policy ARNs that apply to the vended session credentials.

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

      Returns:
      A list of managed policy ARNs that apply to the vended session credentials.

    • name

      public final String name()

      The name of the profile.

      Returns:
      The name of the profile.

    • requireInstanceProperties

      public final Boolean requireInstanceProperties()

      Specifies whether instance properties are required in temporary credential requests with this profile.

      Returns:
      Specifies whether instance properties are required in temporary credential requests with this profile.

    • hasRoleArns

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

    • roleArns

      public final List<String> roleArns()

      A list of IAM roles that this profile can assume in a temporary credential request.

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

      Returns:
      A list of IAM roles that this profile can assume in a temporary credential request.

    • sessionPolicy

      public final String sessionPolicy()

      A session policy that applies to the trust boundary of the vended session credentials.

      Returns:
      A session policy that applies to the trust boundary of the vended session credentials.

    • 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 List<Tag> tags()

      The tags to attach to the profile.

      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 to attach to the profile.

    • toBuilder

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

    • builder

      public static CreateProfileRequest.Builder builder()

    • serializableBuilderClass

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