Package software.amazon.awscdk.mixins.preview.services.location.mixins

Class CfnAPIKeyMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.services.location.mixins.CfnAPIKeyMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnAPIKeyMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAPIKeyMixinProps

@Stability(Stable)
@Internal
public static final class CfnAPIKeyMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAPIKeyMixinProps

An implementation for CfnAPIKeyMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.location.mixins.CfnAPIKeyMixinProps

CfnAPIKeyMixinProps.Builder, CfnAPIKeyMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAPIKeyMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAPIKeyMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDescription()	Updates the description for the API key resource.
final String	getExpireTime()	The optional timestamp for when the API key resource will expire in ISO 8601 format .
final Object	getForceDelete()	ForceDelete bypasses an API key's expiry conditions and deletes the key.
final Object	getForceUpdate()	The boolean flag to be included for updating ExpireTime or Restrictions details.
final String	getKeyName()	A custom name for the API key resource.
final Object	getNoExpiry()	Whether the API key should expire.
final Object	getRestrictions()	The API key restrictions for the API key resource.
final List<CfnTag>	getTags()	Applies one or more tags to the map resource.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(CfnAPIKeyMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAPIKeyMixinProps.Builder.

Method Details

getDescription

public final String getDescription()

Description copied from interface: CfnAPIKeyMixinProps

Updates the description for the API key resource.

Specified by:

getDescription in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-description

getExpireTime

public final String getExpireTime()

Description copied from interface: CfnAPIKeyMixinProps

The optional timestamp for when the API key resource will expire in ISO 8601 format .

Specified by:

getExpireTime in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-expiretime

getForceDelete

public final Object getForceDelete()

Description copied from interface: CfnAPIKeyMixinProps

ForceDelete bypasses an API key's expiry conditions and deletes the key.

Set the parameter true to delete the key or to false to not preemptively delete the API key.

Valid values: true , or false .

This action is irreversible. Only use ForceDelete if you are certain the key is no longer in use.

Returns union: either Boolean or IResolvable

Specified by:

getForceDelete in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forcedelete

getForceUpdate

public final Object getForceUpdate()

Description copied from interface: CfnAPIKeyMixinProps

The boolean flag to be included for updating ExpireTime or Restrictions details.

Must be set to true to update an API key resource that has been used in the past 7 days. False if force update is not preferred.

Returns union: either Boolean or IResolvable

Specified by:

getForceUpdate in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-forceupdate

getKeyName

public final String getKeyName()

Description copied from interface: CfnAPIKeyMixinProps

A custom name for the API key resource.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
• Must be a unique API key name.
• No spaces allowed. For example, ExampleAPIKey .

Specified by:

getKeyName in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-keyname

getNoExpiry

public final Object getNoExpiry()

Description copied from interface: CfnAPIKeyMixinProps

Whether the API key should expire.

Set to true to set the API key to have no expiration time.

Returns union: either Boolean or IResolvable

Specified by:

getNoExpiry in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-noexpiry

getRestrictions

public final Object getRestrictions()

Description copied from interface: CfnAPIKeyMixinProps

The API key restrictions for the API key resource.

Returns union: either IResolvable or CfnAPIKeyPropsMixin.ApiKeyRestrictionsProperty

Specified by:

getRestrictions in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-restrictions

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnAPIKeyMixinProps

Applies one or more tags to the map resource.

A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Specified by:

getTags in interface CfnAPIKeyMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html#cfn-location-apikey-tags

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object