class ConfigurationSource
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.ConfigurationSource |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#ConfigurationSource |
Java | software.amazon.awscdk.services.appconfig.alpha.ConfigurationSource |
Python | aws_cdk.aws_appconfig_alpha.ConfigurationSource |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » ConfigurationSource |
⚠️ Deprecated: undefined
Defines the integrated configuration sources.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_s3 as s3 } from 'aws-cdk-lib';
declare const bucket: s3.Bucket;
declare const key: kms.Key;
const configurationSource = appconfig_alpha.ConfigurationSource.fromBucket(bucket, 'objectKey', /* all optional props */ key);
Initializer
new ConfigurationSource()
⚠️ Deprecated: undefined
Properties
Name | Type | Description |
---|---|---|
location | string | The URI of the configuration source. |
type | Configuration | The type of the configuration source. |
key? | IKey | The KMS Key that encrypts the configuration. |
locationUri
⚠️ Deprecated: undefined
Type:
string
The URI of the configuration source.
type
⚠️ Deprecated: undefined
Type:
Configuration
The type of the configuration source.
key?
⚠️ Deprecated: undefined
Type:
IKey
(optional)
The KMS Key that encrypts the configuration.
Methods
Name | Description |
---|---|
static from | Defines configuration content from an Amazon S3 bucket. |
static from | Defines configuration content from a Systems Manager (SSM) document. |
static from | Defines configuration content from a Systems Manager (SSM) Parameter Store parameter. |
static from | Defines configuration content from AWS CodePipeline. |
static from | Defines configuration content from an AWS Secrets Manager secret. |
Bucket(bucket, objectKey, key?)
static frompublic static fromBucket(bucket: IBucket, objectKey: string, key?: IKey): ConfigurationSource
⚠️ Deprecated: undefined
Parameters
- bucket
IBucket
— The S3 bucket where the configuration is stored. - objectKey
string
— The path to the configuration. - key
IKey
— The KMS Key that the bucket is encrypted with.
Returns
Defines configuration content from an Amazon S3 bucket.
CfnDocument(document)
static frompublic static fromCfnDocument(document: CfnDocument): ConfigurationSource
⚠️ Deprecated: undefined
Parameters
- document
Cfn
— The SSM document where the configuration is stored.Document
Returns
Defines configuration content from a Systems Manager (SSM) document.
Parameter(parameter, key?)
static frompublic static fromParameter(parameter: IParameter, key?: IKey): ConfigurationSource
⚠️ Deprecated: undefined
Parameters
- parameter
IParameter
— The parameter where the configuration is stored. - key
IKey
— The KMS Key that the secure string is encrypted with.
Returns
Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.
Pipeline(pipeline)
static frompublic static fromPipeline(pipeline: IPipeline): ConfigurationSource
⚠️ Deprecated: undefined
Parameters
- pipeline
IPipeline
— The pipeline where the configuration is stored.
Returns
Defines configuration content from AWS CodePipeline.
Secret(secret)
static frompublic static fromSecret(secret: ISecret): ConfigurationSource
⚠️ Deprecated: undefined
Parameters
- secret
ISecret
— The secret where the configuration is stored.
Returns
Defines configuration content from an AWS Secrets Manager secret.