Class CfnConfigurationProfile
The AWS::AppConfig::ConfigurationProfile
resource creates a configuration profile that enables AWS AppConfig to access the configuration source.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConfigurationProfile : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnConfigurationProfile
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
Valid configuration sources include AWS Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 . A configuration profile includes the following information.
AWS AppConfig requires that you create resources and deploy a configuration in the following order:
For more information, see AWS AppConfig in the AWS AppConfig User Guide .
CloudformationResource: AWS::AppConfig::ConfigurationProfile
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.AppConfig;
var cfnConfigurationProfile = new CfnConfigurationProfile(this, "MyCfnConfigurationProfile", new CfnConfigurationProfileProps {
ApplicationId = "applicationId",
LocationUri = "locationUri",
Name = "name",
// the properties below are optional
Description = "description",
KmsKeyIdentifier = "kmsKeyIdentifier",
RetrievalRoleArn = "retrievalRoleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type",
Validators = new [] { new ValidatorsProperty {
Content = "content",
Type = "type"
} }
});
Synopsis
Constructors
CfnConfigurationProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnConfigurationProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnConfigurationProfile(Construct, String, ICfnConfigurationProfileProps) |
Properties
ApplicationId | The application ID. |
AttrConfigurationProfileId | The configuration profile ID. |
AttrKmsKeyArn | The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the configuration profile. |
KmsKeyIdentifier | The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated. |
LocationUri | A URI to locate the configuration. |
Name | A name for the configuration profile. |
RetrievalRoleArn | The ARN of an IAM role with permission to access the configuration at the specified |
Tags | Metadata to assign to the configuration profile. |
Type | The type of configurations contained in the profile. |
Validators | A list of methods for validating the configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnConfigurationProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnConfigurationProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnConfigurationProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnConfigurationProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnConfigurationProfile(Construct, String, ICfnConfigurationProfileProps)
public CfnConfigurationProfile(Construct scope, string id, ICfnConfigurationProfileProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnConfigurationProfileProps
Resource properties.
Properties
ApplicationId
The application ID.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrConfigurationProfileId
The configuration profile ID.
public virtual string AttrConfigurationProfileId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ConfigurationProfileId
AttrKmsKeyArn
The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store.
public virtual string AttrKmsKeyArn { get; }
Property Value
System.String
Remarks
This attribute is only used for hosted
configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
CloudformationAttribute: KmsKeyArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the configuration profile.
public virtual string Description { get; set; }
Property Value
System.String
KmsKeyIdentifier
The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
public virtual string KmsKeyIdentifier { get; set; }
Property Value
System.String
LocationUri
A URI to locate the configuration.
public virtual string LocationUri { get; set; }
Property Value
System.String
Remarks
You can specify the following:.
Name
A name for the configuration profile.
public virtual string Name { get; set; }
Property Value
System.String
RetrievalRoleArn
The ARN of an IAM role with permission to access the configuration at the specified LocationUri
.
public virtual string RetrievalRoleArn { get; set; }
Property Value
System.String
Tags
Metadata to assign to the configuration profile.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Type
The type of configurations contained in the profile.
public virtual string Type { get; set; }
Property Value
System.String
Validators
A list of methods for validating the configuration.
public virtual object Validators { get; set; }
Property Value
System.Object
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>