Class CfnExtension
A CloudFormation AWS::AppConfig::Extension
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.AWS.AppConfig.dll
Syntax (csharp)
public class CfnExtension : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnExtension
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates an AWS AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AWS AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the AWS authored extensions provided by AWS AppConfig . For an AWS AppConfig extension that uses AWS Lambda , you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the AWS authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri
field for the new extension version.
For more information about extensions, see Working with AWS AppConfig extensions in the AWS AppConfig User Guide .
CloudformationResource: AWS::AppConfig::Extension
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html
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 actions;
var cfnExtension = new CfnExtension(this, "MyCfnExtension", new CfnExtensionProps {
Actions = actions,
Name = "name",
// the properties below are optional
Description = "description",
LatestVersionNumber = 123,
Parameters = new Dictionary<string, object> {
{ "parametersKey", new ParameterProperty {
Required = false,
// the properties below are optional
Description = "description"
} }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnExtension(Construct, String, ICfnExtensionProps) | Create a new |
CfnExtension(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnExtension(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Actions | The actions defined in the extension. |
AttrArn | The system-generated Amazon Resource Name (ARN) for the extension. |
AttrId | The system-generated ID of the extension. |
AttrVersionNumber | The extension version number. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | Information about the extension. |
LatestVersionNumber | You can omit this field when you create an extension. |
Name | A name for the extension. |
Parameters | The parameters accepted by the extension. |
Tags | Adds one or more tags for the specified extension. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnExtension(Construct, String, ICfnExtensionProps)
Create a new AWS::AppConfig::Extension
.
public CfnExtension(Construct scope, string id, ICfnExtensionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnExtensionProps
- resource properties.
CfnExtension(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnExtension(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnExtension(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnExtension(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Actions
The actions defined in the extension.
public virtual object Actions { get; set; }
Property Value
System.Object
Remarks
AttrArn
The system-generated Amazon Resource Name (ARN) for the extension.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The system-generated ID of the extension.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrVersionNumber
The extension version number.
public virtual double AttrVersionNumber { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: VersionNumber
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
Information about the extension.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
LatestVersionNumber
You can omit this field when you create an extension.
public virtual Nullable<double> LatestVersionNumber { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.
Name
A name for the extension.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Each extension name in your account must be unique. Extension versions use the same name.
Parameters
The parameters accepted by the extension.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
You specify parameter values when you associate the extension to an AWS AppConfig resource by using the CreateExtensionAssociation
API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.
Tags
Adds one or more tags for the specified extension.
public virtual TagManager Tags { get; }
Property Value
Remarks
Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.
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>