Package software.amazon.awscdk.services.bedrock

Class CfnGuardrailVersion

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.bedrock.CfnGuardrailVersion

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-21T06:34:04.310Z")
@Stability(Stable)
public class CfnGuardrailVersion
extends CfnResource
implements IInspectable

Creates a version of the guardrail.

Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

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.bedrock.*;
 CfnGuardrailVersion cfnGuardrailVersion = CfnGuardrailVersion.Builder.create(this, "MyCfnGuardrailVersion")
         .guardrailIdentifier("guardrailIdentifier")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrailversion.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnGuardrailVersion.Builder	A fluent builder for CfnGuardrailVersion.

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	CfnGuardrailVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGuardrailVersion(software.amazon.jsii.JsiiObjectRef objRef)
	CfnGuardrailVersion(software.constructs.Construct scope, String id, CfnGuardrailVersionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrGuardrailArn()	The ARN of the guardrail.
String	getAttrGuardrailId()	The unique identifier of the guardrail.
String	getAttrVersion()	The version of the guardrail.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description of the guardrail version.
String	getGuardrailIdentifier()	The unique identifier of the guardrail.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description of the guardrail version.
void	setGuardrailIdentifier(String value)	The unique identifier of the guardrail.

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

CfnGuardrailVersion

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

CfnGuardrailVersion

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

CfnGuardrailVersion

@Stability(Stable)
public CfnGuardrailVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnGuardrailVersionProps 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.

getAttrGuardrailArn

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

The ARN of the guardrail.

getAttrGuardrailId

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

The unique identifier of the guardrail.

getAttrVersion

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

The version of the guardrail.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getGuardrailIdentifier

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

The unique identifier of the guardrail.

setGuardrailIdentifier

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

The unique identifier of the guardrail.

getDescription

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

A description of the guardrail version.

setDescription

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

A description of the guardrail version.