Interface CfnApiKeyProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:16.306Z") @Stability(Stable) public interface CfnApiKeyProps extends
Properties for defining a `CfnApiKey`.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnApiKeyProps cfnApiKeyProps = CfnApiKeyProps.builder()
  • Method Details

    • getCustomerId

      @Stability(Stable) @Nullable default String getCustomerId()
      An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the ApiKey.
    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      Specifies whether the ApiKey can be used by callers.
    • getGenerateDistinctId

      @Stability(Stable) @Nullable default Object getGenerateDistinctId()
      Specifies whether ( `true` ) or not ( `false` ) the key identifier is distinct from the created API key value.

      This parameter is deprecated and should not be used.

    • getName

      @Stability(Stable) @Nullable default String getName()
      A name for the API key.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type .

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

    • getStageKeys

      @Stability(Stable) @Nullable default Object getStageKeys()
      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      The key-value map of strings.

      The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

    • getValue

      @Stability(Stable) @Nullable default String getValue()
      Specifies a value of the API key.
    • builder

      @Stability(Stable) static CfnApiKeyProps.Builder builder()
      a CfnApiKeyProps.Builder of CfnApiKeyProps