Package software.amazon.awssdk.services.lexmodelsv2.model

Class CreateResourcePolicyStatementRequest

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

  • Method Details

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

      Returns:
      The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

    • statementId

      public final String statementId()

      The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

      Returns:
      The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

    • effect

      public final Effect effect()

      Determines whether the statement allows or denies access to the resource.

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

      Returns:
      Determines whether the statement allows or denies access to the resource.
      See Also:

    • effectAsString

      public final String effectAsString()

      Determines whether the statement allows or denies access to the resource.

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

      Returns:
      Determines whether the statement allows or denies access to the resource.
      See Also:

    • hasPrincipal

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

    • principal

      public final List<Principal> principal()

      An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.

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

      Returns:
      An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.

    • hasAction

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

    • action

      public final List<String> action()

      The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.

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

      Returns:
      The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.

    • hasCondition

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

    • condition

      public final Map<String,Map<String,String>> condition()

      Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.

      For more information, see IAM JSON policy elements: Condition .

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

      Returns:
      Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.

      For more information, see IAM JSON policy elements: Condition .

    • expectedRevisionId

      public final String expectedRevisionId()

      The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

      If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

      Returns:
      The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

      If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

    • toBuilder

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

    • builder

      public static CreateResourcePolicyStatementRequest.Builder builder()

    • serializableBuilderClass

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