Class CfnApiKeyProps.Jsii$Proxy
- All Implemented Interfaces:
CfnApiKeyProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnApiKeyProps
CfnApiKeyProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.CfnApiKeyProps
CfnApiKeyProps.Builder, CfnApiKeyProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnApiKeyProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnApiKeyProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringAn AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.final StringThe description of the ApiKey.final ObjectSpecifies whether the ApiKey can be used by callers.final ObjectSpecifies whether (true) or not (false) the key identifier is distinct from the created API key value.final StringgetName()A name for the API key.final ObjectDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.getTags()The key-value map of strings.final StringgetValue()Specifies a value of the API key.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnApiKeyProps.Builder.
-
-
Method Details
-
getCustomerId
Description copied from interface:CfnApiKeyPropsAn AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.- Specified by:
getCustomerIdin interfaceCfnApiKeyProps- See Also:
-
getDescription
Description copied from interface:CfnApiKeyPropsThe description of the ApiKey.- Specified by:
getDescriptionin interfaceCfnApiKeyProps- See Also:
-
getEnabled
Description copied from interface:CfnApiKeyPropsSpecifies whether the ApiKey can be used by callers.Returns union: either
BooleanorIResolvableDefault: - false
- Specified by:
getEnabledin interfaceCfnApiKeyProps- See Also:
-
getGenerateDistinctId
Description copied from interface:CfnApiKeyPropsSpecifies 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.
Returns union: either
BooleanorIResolvable- Specified by:
getGenerateDistinctIdin interfaceCfnApiKeyProps- See Also:
-
getName
Description copied from interface:CfnApiKeyPropsA 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.
- Specified by:
getNamein interfaceCfnApiKeyProps- See Also:
-
getStageKeys
Description copied from interface:CfnApiKeyPropsDEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnApiKey.StageKeyProperty>- Specified by:
getStageKeysin interfaceCfnApiKeyProps- See Also:
-
getTags
Description copied from interface:CfnApiKeyPropsThe 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.- Specified by:
getTagsin interfaceCfnApiKeyProps- See Also:
-
getValue
Description copied from interface:CfnApiKeyPropsSpecifies a value of the API key.- Specified by:
getValuein interfaceCfnApiKeyProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-