Package software.amazon.awssdk.services.servicecatalog.model

Class UpdateConstraintRequest

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

  • Method Details

    • acceptLanguage

      public final String acceptLanguage()

      The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      The language code.

      • jp - Japanese

      • zh - Chinese

    • id

      public final String id()

      The identifier of the constraint.

      Returns:
      The identifier of the constraint.

    • description

      public final String description()

      The updated description of the constraint.

      Returns:
      The updated description of the constraint.

    • parameters

      public final String parameters()

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can't use both.

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

      Returns:
      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can't use both.

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

    • toBuilder

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

    • builder

      public static UpdateConstraintRequest.Builder builder()

    • serializableBuilderClass

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