Skip to content

Latest commit

 

History

History
255 lines (153 loc) · 8.49 KB

API.md.md

File metadata and controls

255 lines (153 loc) · 8.49 KB
Raw

API Reference

Constructs

SimpleAppConfig

Custom construct to quickly setup app config resouce based on the passed in {@link SimpleAppConfigProps}.

This construct does the following:

  1. Setup applicationName/applicationEnvironment/configurationProfileName.
  2. Add/update configurationContent.
  3. Apply the add/update immediately.

Initializers 

import { SimpleAppConfig } from 'cdk-appconfig'

new SimpleAppConfig(scope: Construct, id: string, props: SimpleAppConfigProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SimpleAppConfigProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { SimpleAppConfig } from 'cdk-appconfig'

SimpleAppConfig.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
application aws-cdk-lib.aws_appconfig.CfnApplication No description.
configurationProfile aws-cdk-lib.aws_appconfig.CfnConfigurationProfile No description.
deployment aws-cdk-lib.aws_appconfig.CfnDeployment No description.
environment aws-cdk-lib.aws_appconfig.CfnEnvironment No description.
hostedConfigurationVersion aws-cdk-lib.aws_appconfig.CfnHostedConfigurationVersion No description.
immediateDeploymentStrategy aws-cdk-lib.aws_appconfig.CfnDeploymentStrategy No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

applicationRequired 
public readonly application: CfnApplication;
  • Type: aws-cdk-lib.aws_appconfig.CfnApplication
configurationProfileRequired 
public readonly configurationProfile: CfnConfigurationProfile;
  • Type: aws-cdk-lib.aws_appconfig.CfnConfigurationProfile
deploymentRequired 
public readonly deployment: CfnDeployment;
  • Type: aws-cdk-lib.aws_appconfig.CfnDeployment
environmentRequired 
public readonly environment: CfnEnvironment;
  • Type: aws-cdk-lib.aws_appconfig.CfnEnvironment
hostedConfigurationVersionRequired 
public readonly hostedConfigurationVersion: CfnHostedConfigurationVersion;
  • Type: aws-cdk-lib.aws_appconfig.CfnHostedConfigurationVersion
immediateDeploymentStrategyRequired 
public readonly immediateDeploymentStrategy: CfnDeploymentStrategy;
  • Type: aws-cdk-lib.aws_appconfig.CfnDeploymentStrategy

Structs

SimpleAppConfigProps

Props for {@link SimpleAppConfig} construct.

Initializer 

import { SimpleAppConfigProps } from 'cdk-appconfig'

const simpleAppConfigProps: SimpleAppConfigProps = { ... }

Properties

Name Type Description
applicationEnvironment string The name of the environment for deployment.
applicationName string The name of the app config application.
configurationContent {[ key: string ]: any} | object The content within the configuration profile.
configurationProfileName string The name for the configuration profile within the application.
applicationEnvironmentRequired 
public readonly applicationEnvironment: string;
  • Type: string

The name of the environment for deployment.

(Ex: Production)

applicationNameRequired 
public readonly applicationName: string;
  • Type: string

The name of the app config application.

(Ex: MyApplication)

configurationContentRequired 
public readonly configurationContent: {[ key: string ]: any} | object;
  • Type: {[ key: string ]: any} | object

The content within the configuration profile.

configurationProfileNameRequired 
public readonly configurationProfileName: string;
  • Type: string

The name for the configuration profile within the application.