Class CfnAPIKey

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnAPIKey
Inherited Members
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAPIKey : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnAPIKey Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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

CloudformationResource: AWS::Location::APIKey

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 cfnAPIKey = new CfnAPIKey(this, "MyCfnAPIKey", 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

CfnAPIKey(Construct, string, ICfnAPIKeyProps)

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

Properties

AttrArn

The Amazon Resource Name (ARN) for the resource.
AttrCreateTime

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
AttrKeyArn

The Amazon Resource Name (ARN) for the API key resource.
AttrUpdateTime

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

Constructors

CfnAPIKey(Construct, string, ICfnAPIKeyProps)

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

public CfnAPIKey(Construct scope, string id, ICfnAPIKeyProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAPIKeyProps

Resource properties.

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) for the resource.

public virtual string AttrArn { get; }
Property Value

string

Remarks

Used when you need to specify a resource across all AWS .

CloudformationAttribute: Arn

AttrCreateTime

The timestamp for when the API key resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

public virtual string AttrCreateTime { get; }
Property Value

string

Remarks

CloudformationAttribute: CreateTime

AttrKeyArn

The Amazon Resource Name (ARN) for the API key resource.

public virtual string AttrKeyArn { get; }
Property Value

string

Remarks

Used when you need to specify a resource across all AWS .

CloudformationAttribute: KeyArn

AttrUpdateTime

The timestamp for when the API key resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

public virtual string AttrUpdateTime { get; }
Property Value

string

Remarks

CloudformationAttribute: UpdateTime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

CfnProperties

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Description

Updates the description for the API key resource.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

ExpireTime

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

public virtual string? ExpireTime { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

ForceDelete

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

public virtual object? ForceDelete { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

ForceUpdate

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

public virtual object? ForceUpdate { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

KeyName

A custom name for the API key resource.

public virtual string KeyName { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

NoExpiry

Whether the API key should expire.

public virtual object? NoExpiry { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Restrictions

The API key restrictions for the API key resource.

public virtual object Restrictions { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Tags

Applies one or more tags to the map resource.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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

CloudformationResource: AWS::Location::APIKey

ExampleMetadata: fixture=_generated

Implements