Class CfnApiKey.StageKeyProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

StageKey is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.

public class CfnApiKey.StageKeyProperty : CfnApiKey.IStageKeyProperty

Inheritance

object

CfnApiKey.StageKeyProperty

Implements

CfnApiKey.IStageKeyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

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

             var stageKeyProperty = new StageKeyProperty {
                 RestApiId = "restApiId",
                 StageName = "stageName"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html

ExampleMetadata: fixture=_generated

Constructors

StageKeyProperty()

public StageKeyProperty()

Properties

RestApiId

The string identifier of the associated RestApi.

public string? RestApiId { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid

StageName

The stage name associated with the stage key.

public string? StageName { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename