Class CreateProvisionedProductPlanRequest

    • Method Detail

      • acceptLanguage

        public final String acceptLanguage()

        The language code.

        • jp - Japanese

        • zh - Chinese

        Returns:
        The language code.

        • jp - Japanese

        • zh - Chinese

      • planName

        public final String planName()

        The name of the plan.

        Returns:
        The name of the plan.
      • hasNotificationArns

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

        public final List<String> notificationArns()

        Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

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

        Returns:
        Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
      • pathId

        public final String pathId()

        The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

        Returns:
        The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
      • productId

        public final String productId()

        The product identifier.

        Returns:
        The product identifier.
      • provisionedProductName

        public final String provisionedProductName()

        A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.

        Returns:
        A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
      • provisioningArtifactId

        public final String provisioningArtifactId()

        The identifier of the provisioning artifact.

        Returns:
        The identifier of the provisioning artifact.
      • hasProvisioningParameters

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

        public final List<UpdateProvisioningParameter> provisioningParameters()

        Parameters specified by the administrator that are required for provisioning the product.

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

        Returns:
        Parameters specified by the administrator that are required for provisioning the product.
      • idempotencyToken

        public final String idempotencyToken()

        A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

        Returns:
        A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
      • 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()

        One or more tags.

        If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

        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:
        One or more tags.

        If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

      • 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