Package software.amazon.awscdk.services.location

Class CfnAPIKey.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnAPIKey.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAPIKey>

Enclosing class:

CfnAPIKey

@Stability(Stable)
public static final class CfnAPIKey.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAPIKey>

A fluent builder for CfnAPIKey.

Method Summary

Modifier and Type	Method	Description
CfnAPIKey	build()
static CfnAPIKey.Builder	create(software.constructs.Construct scope, String id)
CfnAPIKey.Builder	description(String description)	Updates the description for the API key resource.
CfnAPIKey.Builder	expireTime(String expireTime)	The optional timestamp for when the API key resource will expire in ISO 8601 format .
CfnAPIKey.Builder	forceDelete(Boolean forceDelete)	ForceDelete bypasses an API key's expiry conditions and deletes the key.
CfnAPIKey.Builder	forceDelete(IResolvable forceDelete)	ForceDelete bypasses an API key's expiry conditions and deletes the key.
CfnAPIKey.Builder	forceUpdate(Boolean forceUpdate)	The boolean flag to be included for updating ExpireTime or Restrictions details.
CfnAPIKey.Builder	forceUpdate(IResolvable forceUpdate)	The boolean flag to be included for updating ExpireTime or Restrictions details.
CfnAPIKey.Builder	keyName(String keyName)	A custom name for the API key resource.
CfnAPIKey.Builder	noExpiry(Boolean noExpiry)	Whether the API key should expire.
CfnAPIKey.Builder	noExpiry(IResolvable noExpiry)	Whether the API key should expire.
CfnAPIKey.Builder	restrictions(IResolvable restrictions)	The API key restrictions for the API key resource.
CfnAPIKey.Builder	restrictions(CfnAPIKey.ApiKeyRestrictionsProperty restrictions)	The API key restrictions for the API key resource.
CfnAPIKey.Builder	tags(List<? extends CfnTag> tags)	Applies one or more tags to the map resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAPIKey.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAPIKey.Builder.

keyName

@Stability(Stable)
public CfnAPIKey.Builder keyName(String keyName)

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 .

Parameters:

keyName - A custom name for the API key resource. This parameter is required.

Returns:

this

See Also:

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

restrictions

@Stability(Stable)
public CfnAPIKey.Builder restrictions(IResolvable restrictions)

The API key restrictions for the API key resource.

Parameters:

restrictions - The API key restrictions for the API key resource. This parameter is required.

Returns:

this

See Also:

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

restrictions

@Stability(Stable)
public CfnAPIKey.Builder restrictions(CfnAPIKey.ApiKeyRestrictionsProperty restrictions)

The API key restrictions for the API key resource.

Parameters:

restrictions - The API key restrictions for the API key resource. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnAPIKey.Builder description(String description)

Updates the description for the API key resource.

Parameters:

description - Updates the description for the API key resource. This parameter is required.

Returns:

this

See Also:

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

expireTime

@Stability(Stable)
public CfnAPIKey.Builder expireTime(String expireTime)

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

Parameters:

expireTime - The optional timestamp for when the API key resource will expire in ISO 8601 format . This parameter is required.

Returns:

this

See Also:

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

forceDelete

@Stability(Stable)
public CfnAPIKey.Builder forceDelete(Boolean forceDelete)

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.

Parameters:

forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. This parameter is required.

Returns:

this

See Also:

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

forceDelete

@Stability(Stable)
public CfnAPIKey.Builder forceDelete(IResolvable forceDelete)

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.

Parameters:

forceDelete - ForceDelete bypasses an API key's expiry conditions and deletes the key. This parameter is required.

Returns:

this

See Also:

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

forceUpdate

@Stability(Stable)
public CfnAPIKey.Builder forceUpdate(Boolean forceUpdate)

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.

Parameters:

forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details. This parameter is required.

Returns:

this

See Also:

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

forceUpdate

@Stability(Stable)
public CfnAPIKey.Builder forceUpdate(IResolvable forceUpdate)

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.

Parameters:

forceUpdate - The boolean flag to be included for updating ExpireTime or Restrictions details. This parameter is required.

Returns:

this

See Also:

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

noExpiry

@Stability(Stable)
public CfnAPIKey.Builder noExpiry(Boolean noExpiry)

Whether the API key should expire.

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

Parameters:

noExpiry - Whether the API key should expire. This parameter is required.

Returns:

this

See Also:

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

noExpiry

@Stability(Stable)
public CfnAPIKey.Builder noExpiry(IResolvable noExpiry)

Whether the API key should expire.

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

Parameters:

noExpiry - Whether the API key should expire. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAPIKey.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - Applies one or more tags to the map resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAPIKey build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAPIKey>

Returns:

a newly built instance of CfnAPIKey.