Package software.amazon.awscdk.cfnpropertymixins.services.location

Class CfnAPIKeyMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.location.CfnAPIKeyMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAPIKeyMixinProps>

Enclosing interface:

CfnAPIKeyMixinProps

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

A builder for CfnAPIKeyMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAPIKeyMixinProps	build()	Builds the configured instance.
CfnAPIKeyMixinProps.Builder	description(String description)	Sets the value of CfnAPIKeyMixinProps.getDescription()
CfnAPIKeyMixinProps.Builder	expireTime(String expireTime)	Sets the value of CfnAPIKeyMixinProps.getExpireTime()
CfnAPIKeyMixinProps.Builder	forceDelete(Boolean forceDelete)	Sets the value of CfnAPIKeyMixinProps.getForceDelete()
CfnAPIKeyMixinProps.Builder	forceDelete(IResolvable forceDelete)	Sets the value of CfnAPIKeyMixinProps.getForceDelete()
CfnAPIKeyMixinProps.Builder	forceUpdate(Boolean forceUpdate)	Sets the value of CfnAPIKeyMixinProps.getForceUpdate()
CfnAPIKeyMixinProps.Builder	forceUpdate(IResolvable forceUpdate)	Sets the value of CfnAPIKeyMixinProps.getForceUpdate()
CfnAPIKeyMixinProps.Builder	keyName(String keyName)	Sets the value of CfnAPIKeyMixinProps.getKeyName()
CfnAPIKeyMixinProps.Builder	noExpiry(Boolean noExpiry)	Sets the value of CfnAPIKeyMixinProps.getNoExpiry()
CfnAPIKeyMixinProps.Builder	noExpiry(IResolvable noExpiry)	Sets the value of CfnAPIKeyMixinProps.getNoExpiry()
CfnAPIKeyMixinProps.Builder	restrictions(CfnAPIKeyPropsMixin.ApiKeyRestrictionsProperty restrictions)	Sets the value of CfnAPIKeyMixinProps.getRestrictions()
CfnAPIKeyMixinProps.Builder	restrictions(IResolvable restrictions)	Sets the value of CfnAPIKeyMixinProps.getRestrictions()
CfnAPIKeyMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAPIKeyMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

description

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

Sets the value of CfnAPIKeyMixinProps.getDescription()

Parameters:

description - Updates the description for the API key resource.

Returns:

this

expireTime

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

Sets the value of CfnAPIKeyMixinProps.getExpireTime()

Parameters:

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

Returns:

this

forceDelete

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

Sets the value of CfnAPIKeyMixinProps.getForceDelete()

Parameters:

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.

Returns:

this

forceDelete

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

Sets the value of CfnAPIKeyMixinProps.getForceDelete()

Parameters:

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.

Returns:

this

forceUpdate

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

Sets the value of CfnAPIKeyMixinProps.getForceUpdate()

Parameters:

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.

Returns:

this

forceUpdate

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

Sets the value of CfnAPIKeyMixinProps.getForceUpdate()

Parameters:

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.

Returns:

this

keyName

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

Sets the value of CfnAPIKeyMixinProps.getKeyName()

Parameters:

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 .

Returns:

this

noExpiry

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

Sets the value of CfnAPIKeyMixinProps.getNoExpiry()

Parameters:

noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

this

noExpiry

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

Sets the value of CfnAPIKeyMixinProps.getNoExpiry()

Parameters:

noExpiry - Whether the API key should expire. Set to true to set the API key to have no expiration time.

Returns:

this

restrictions

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

Sets the value of CfnAPIKeyMixinProps.getRestrictions()

Parameters:

restrictions - The API key restrictions for the API key resource.

Returns:

this

restrictions

@Stability(Stable)
public CfnAPIKeyMixinProps.Builder restrictions(CfnAPIKeyPropsMixin.ApiKeyRestrictionsProperty restrictions)

Sets the value of CfnAPIKeyMixinProps.getRestrictions()

Parameters:

restrictions - The API key restrictions for the API key resource.

Returns:

this

tags

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

Sets the value of CfnAPIKeyMixinProps.getTags()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnAPIKeyMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAPIKeyMixinProps

Throws:

NullPointerException - if any required attribute was not provided