Interface ICfnAPIKeyMixinProps

Properties for CfnAPIKeyPropsMixin.

Namespace: Amazon.CDK.Mixins.Preview.AWS.Location.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface ICfnAPIKeyMixinProps

Syntax (vb)

Public Interface ICfnAPIKeyMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Location.Mixins;

             var cfnAPIKeyMixinProps = new CfnAPIKeyMixinProps {
                 Description = "description",
                 ExpireTime = "expireTime",
                 ForceDelete = false,
                 ForceUpdate = false,
                 KeyName = "keyName",
                 NoExpiry = false,
                 Restrictions = new ApiKeyRestrictionsProperty {
                     AllowActions = new [] { "allowActions" },
                     AllowAndroidApps = new [] { new AndroidAppProperty {
                         CertificateFingerprint = "certificateFingerprint",
                         Package = "package"
                     } },
                     AllowAppleApps = new [] { new AppleAppProperty {
                         BundleId = "bundleId"
                     } },
                     AllowReferers = new [] { "allowReferers" },
                     AllowResources = new [] { "allowResources" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Description	Updates the description for the API key resource.
ExpireTime	The optional timestamp for when the API key resource will expire in ISO 8601 format .
ForceDelete	ForceDelete bypasses an API key's expiry conditions and deletes the key.
ForceUpdate	The boolean flag to be included for updating `ExpireTime` or Restrictions details.
KeyName	A custom name for the API key resource.
NoExpiry	Whether the API key should expire.
Restrictions	The API key restrictions for the API key resource.
Tags	Applies one or more tags to the map resource.

Properties

Description

Updates the description for the API key resource.

string? Description { get; }

Property Value

string

Remarks

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

ExpireTime

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

string? ExpireTime { get; }

Property Value

string

Remarks

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

ForceDelete

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

object? ForceDelete { get; }

Property Value

object

Remarks

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.

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

Type union: either bool or IResolvable

ForceUpdate

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

object? ForceUpdate { get; }

Property Value

object

Remarks

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.

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

Type union: either bool or IResolvable

KeyName

A custom name for the API key resource.

string? KeyName { get; }

Property Value

string

Remarks

Requirements:

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

NoExpiry

Whether the API key should expire.

object? NoExpiry { get; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

Restrictions

The API key restrictions for the API key resource.

object? Restrictions { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnAPIKeyPropsMixin.IApiKeyRestrictionsProperty