Show / Hide Table of Contents

Interface IGetContextKeyOptions

Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IGetContextKeyOptions
Syntax (vb)
Public Interface IGetContextKeyOptions
Remarks

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;

            var props;

            var getContextKeyOptions = new GetContextKeyOptions {
                Provider = "provider",

                // the properties below are optional
                AdditionalCacheKey = "additionalCacheKey",
                IncludeEnvironment = false,
                Props = new Dictionary<string, object> {
                    { "propsKey", props }
                }
            };

Synopsis

Properties

AdditionalCacheKey

Adds an additional discriminator to the cdk.context.json cache key.

IncludeEnvironment

Whether to include the stack's account and region automatically.

Props

Provider-specific properties.

Provider

The context provider to query.

Properties

AdditionalCacheKey

Adds an additional discriminator to the cdk.context.json cache key.

string? AdditionalCacheKey { get; }
Property Value

string

Remarks

Default: - no additional cache key

IncludeEnvironment

Whether to include the stack's account and region automatically.

bool? IncludeEnvironment { get; }
Property Value

bool?

Remarks

Default: true

Props

Provider-specific properties.

IDictionary<string, object>? Props { get; }
Property Value

IDictionary<string, object>

Remarks

ExampleMetadata: fixture=_generated

Provider

The context provider to query.

string Provider { get; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Back to top Generated by DocFX