Package software.amazon.awscdk.services.appconfig

Interface CfnExtensionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExtensionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.305Z")
@Stability(Stable)
public interface CfnExtensionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnExtension.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appconfig.*;
 Object actions;
 CfnExtensionProps cfnExtensionProps = CfnExtensionProps.builder()
         .actions(actions)
         .name("name")
         // the properties below are optional
         .description("description")
         .latestVersionNumber(123)
         .parameters(Map.of(
                 "parametersKey", ParameterProperty.builder()
                         .required(false)
                         // the properties below are optional
                         .description("description")
                         .dynamic(false)
                         .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnExtensionProps.Builder	A builder for CfnExtensionProps
static final class	CfnExtensionProps.Jsii$Proxy	An implementation for CfnExtensionProps

Method Summary

Modifier and Type	Method	Description
static CfnExtensionProps.Builder	builder()
Object	getActions()	The actions defined in the extension.
default String	getDescription()	Information about the extension.
default Number	getLatestVersionNumber()	You can omit this field when you create an extension.
String	getName()	A name for the extension.
default Object	getParameters()	The parameters accepted by the extension.
default List<CfnTag>	getTags()	Adds one or more tags for the specified extension.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The actions defined in the extension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-actions

getName

@Stability(Stable)
@NotNull
String getName()

A name for the extension.

Each extension name in your account must be unique. Extension versions use the same name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Information about the extension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-description

getLatestVersionNumber

@Stability(Stable)
@Nullable
default Number getLatestVersionNumber()

You can omit this field when you create an extension.

When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-latestversionnumber

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

The parameters accepted by the extension.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Adds one or more tags for the specified extension.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html#cfn-appconfig-extension-tags

builder

@Stability(Stable)
static CfnExtensionProps.Builder builder()

Returns:

a CfnExtensionProps.Builder of CfnExtensionProps