Class CfnAPIKeyProps
Properties for defining a CfnAPIKey
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAPIKeyProps : Object, ICfnAPIKeyProps
Syntax (vb)
Public Class CfnAPIKeyProps
Inherits Object
Implements ICfnAPIKeyProps
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.AWS.Location;
var cfnAPIKeyProps = new CfnAPIKeyProps {
KeyName = "keyName",
Restrictions = new ApiKeyRestrictionsProperty {
AllowActions = new [] { "allowActions" },
AllowResources = new [] { "allowResources" },
// the properties below are optional
AllowReferers = new [] { "allowReferers" }
},
// the properties below are optional
Description = "description",
ExpireTime = "expireTime",
ForceDelete = false,
ForceUpdate = false,
NoExpiry = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnAPIKeyProps() |
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 |
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. |
Constructors
CfnAPIKeyProps()
public CfnAPIKeyProps()
Properties
Description
Updates the description for the API key resource.
public string Description { get; set; }
Property Value
System.String
Remarks
ExpireTime
The optional timestamp for when the API key resource will expire in ISO 8601 format .
public string ExpireTime { get; set; }
Property Value
System.String
Remarks
ForceDelete
ForceDelete bypasses an API key's expiry conditions and deletes the key.
public object ForceDelete { get; set; }
Property Value
System.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.
ForceUpdate
The boolean flag to be included for updating ExpireTime
or Restrictions details.
public object ForceUpdate { get; set; }
Property Value
System.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.
KeyName
A custom name for the API key resource.
public string KeyName { get; set; }
Property Value
System.String
Remarks
NoExpiry
Whether the API key should expire.
public object NoExpiry { get; set; }
Property Value
System.Object
Remarks
Set to true
to set the API key to have no expiration time.
Restrictions
The API key restrictions for the API key resource.
public object Restrictions { get; set; }
Property Value
System.Object
Remarks
Tags
Applies one or more tags to the map resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.