Package software.amazon.awscdk.services.servicecatalog

Class CfnServiceAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.servicecatalog.CfnServiceAction

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.622Z")
@Stability(Stable)
public class CfnServiceAction
extends CfnResource
implements IInspectable

Creates a self-service action.

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.servicecatalog.*;
 CfnServiceAction cfnServiceAction = CfnServiceAction.Builder.create(this, "MyCfnServiceAction")
         .definition(List.of(DefinitionParameterProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .definitionType("definitionType")
         .name("name")
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-serviceaction.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnServiceAction.Builder	A fluent builder for CfnServiceAction.
static interface	CfnServiceAction.DefinitionParameterProperty	The list of parameters in JSON format.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnServiceAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServiceAction(software.amazon.jsii.JsiiObjectRef objRef)
	CfnServiceAction(software.constructs.Construct scope, String id, CfnServiceActionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAcceptLanguage()	The language code.
String	getAttrId()	The self-service action identifier.
protected Map<String,Object>	getCfnProperties()
Object	getDefinition()	A map that defines the self-service action.
String	getDefinitionType()	The self-service action definition type.
String	getDescription()	The self-service action description.
String	getName()	The self-service action name.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAcceptLanguage(String value)	The language code.
void	setDefinition(List<Object> value)	A map that defines the self-service action.
void	setDefinition(IResolvable value)	A map that defines the self-service action.
void	setDefinitionType(String value)	The self-service action definition type.
void	setDescription(String value)	The self-service action description.
void	setName(String value)	The self-service action name.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnServiceAction

protected CfnServiceAction(software.amazon.jsii.JsiiObjectRef objRef)

CfnServiceAction

protected CfnServiceAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServiceAction

@Stability(Stable)
public CfnServiceAction(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnServiceActionProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The self-service action identifier.

For example, act-fs7abcd89wxyz .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDefinition

@Stability(Stable)
@NotNull
public Object getDefinition()

A map that defines the self-service action.

setDefinition

@Stability(Stable)
public void setDefinition(@NotNull
 IResolvable value)

A map that defines the self-service action.

setDefinition

@Stability(Stable)
public void setDefinition(@NotNull
 List<Object> value)

A map that defines the self-service action.

getDefinitionType

@Stability(Stable)
@NotNull
public String getDefinitionType()

The self-service action definition type.

setDefinitionType

@Stability(Stable)
public void setDefinitionType(@NotNull
 String value)

The self-service action definition type.

getName

@Stability(Stable)
@NotNull
public String getName()

The self-service action name.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The self-service action name.

getAcceptLanguage

@Stability(Stable)
@Nullable
public String getAcceptLanguage()

The language code.

setAcceptLanguage

@Stability(Stable)
public void setAcceptLanguage(@Nullable
 String value)

The language code.

getDescription

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

The self-service action description.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The self-service action description.