com.pulumi.aws.bedrock.GuardrailArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.bedrock;
import com.pulumi.aws.bedrock.inputs.GuardrailContentPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailContextualGroundingPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailSensitiveInformationPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTimeoutsArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTopicPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailWordPolicyConfigArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class GuardrailArgs extends com.pulumi.resources.ResourceArgs {
public static final GuardrailArgs Empty = new GuardrailArgs();
/**
* Message to return when the guardrail blocks a prompt.
*
*/
@Import(name="blockedInputMessaging", required=true)
private Output blockedInputMessaging;
/**
* @return Message to return when the guardrail blocks a prompt.
*
*/
public Output blockedInputMessaging() {
return this.blockedInputMessaging;
}
/**
* Message to return when the guardrail blocks a model response.
*
*/
@Import(name="blockedOutputsMessaging", required=true)
private Output blockedOutputsMessaging;
/**
* @return Message to return when the guardrail blocks a model response.
*
*/
public Output blockedOutputsMessaging() {
return this.blockedOutputsMessaging;
}
/**
* Content policy config for a guardrail. See Content Policy Config for more information.
*
*/
@Import(name="contentPolicyConfig")
private @Nullable Output contentPolicyConfig;
/**
* @return Content policy config for a guardrail. See Content Policy Config for more information.
*
*/
public Optional> contentPolicyConfig() {
return Optional.ofNullable(this.contentPolicyConfig);
}
/**
* Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
*
*/
@Import(name="contextualGroundingPolicyConfig")
private @Nullable Output contextualGroundingPolicyConfig;
/**
* @return Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
*
*/
public Optional> contextualGroundingPolicyConfig() {
return Optional.ofNullable(this.contextualGroundingPolicyConfig);
}
/**
* Description of the guardrail or its version.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return Description of the guardrail or its version.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* The KMS key with which the guardrail was encrypted at rest.
*
*/
@Import(name="kmsKeyArn")
private @Nullable Output kmsKeyArn;
/**
* @return The KMS key with which the guardrail was encrypted at rest.
*
*/
public Optional> kmsKeyArn() {
return Optional.ofNullable(this.kmsKeyArn);
}
/**
* Name of the guardrail.
*
* The following arguments are optional:
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Name of the guardrail.
*
* The following arguments are optional:
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
*
*/
@Import(name="sensitiveInformationPolicyConfig")
private @Nullable Output sensitiveInformationPolicyConfig;
/**
* @return Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
*
*/
public Optional> sensitiveInformationPolicyConfig() {
return Optional.ofNullable(this.sensitiveInformationPolicyConfig);
}
/**
* Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
@Import(name="timeouts")
private @Nullable Output timeouts;
public Optional> timeouts() {
return Optional.ofNullable(this.timeouts);
}
/**
* Topic policy config for a guardrail. See Topic Policy Config for more information.
*
*/
@Import(name="topicPolicyConfig")
private @Nullable Output topicPolicyConfig;
/**
* @return Topic policy config for a guardrail. See Topic Policy Config for more information.
*
*/
public Optional> topicPolicyConfig() {
return Optional.ofNullable(this.topicPolicyConfig);
}
/**
* Word policy config for a guardrail. See Word Policy Config for more information.
*
*/
@Import(name="wordPolicyConfig")
private @Nullable Output wordPolicyConfig;
/**
* @return Word policy config for a guardrail. See Word Policy Config for more information.
*
*/
public Optional> wordPolicyConfig() {
return Optional.ofNullable(this.wordPolicyConfig);
}
private GuardrailArgs() {}
private GuardrailArgs(GuardrailArgs $) {
this.blockedInputMessaging = $.blockedInputMessaging;
this.blockedOutputsMessaging = $.blockedOutputsMessaging;
this.contentPolicyConfig = $.contentPolicyConfig;
this.contextualGroundingPolicyConfig = $.contextualGroundingPolicyConfig;
this.description = $.description;
this.kmsKeyArn = $.kmsKeyArn;
this.name = $.name;
this.sensitiveInformationPolicyConfig = $.sensitiveInformationPolicyConfig;
this.tags = $.tags;
this.timeouts = $.timeouts;
this.topicPolicyConfig = $.topicPolicyConfig;
this.wordPolicyConfig = $.wordPolicyConfig;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(GuardrailArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private GuardrailArgs $;
public Builder() {
$ = new GuardrailArgs();
}
public Builder(GuardrailArgs defaults) {
$ = new GuardrailArgs(Objects.requireNonNull(defaults));
}
/**
* @param blockedInputMessaging Message to return when the guardrail blocks a prompt.
*
* @return builder
*
*/
public Builder blockedInputMessaging(Output blockedInputMessaging) {
$.blockedInputMessaging = blockedInputMessaging;
return this;
}
/**
* @param blockedInputMessaging Message to return when the guardrail blocks a prompt.
*
* @return builder
*
*/
public Builder blockedInputMessaging(String blockedInputMessaging) {
return blockedInputMessaging(Output.of(blockedInputMessaging));
}
/**
* @param blockedOutputsMessaging Message to return when the guardrail blocks a model response.
*
* @return builder
*
*/
public Builder blockedOutputsMessaging(Output blockedOutputsMessaging) {
$.blockedOutputsMessaging = blockedOutputsMessaging;
return this;
}
/**
* @param blockedOutputsMessaging Message to return when the guardrail blocks a model response.
*
* @return builder
*
*/
public Builder blockedOutputsMessaging(String blockedOutputsMessaging) {
return blockedOutputsMessaging(Output.of(blockedOutputsMessaging));
}
/**
* @param contentPolicyConfig Content policy config for a guardrail. See Content Policy Config for more information.
*
* @return builder
*
*/
public Builder contentPolicyConfig(@Nullable Output contentPolicyConfig) {
$.contentPolicyConfig = contentPolicyConfig;
return this;
}
/**
* @param contentPolicyConfig Content policy config for a guardrail. See Content Policy Config for more information.
*
* @return builder
*
*/
public Builder contentPolicyConfig(GuardrailContentPolicyConfigArgs contentPolicyConfig) {
return contentPolicyConfig(Output.of(contentPolicyConfig));
}
/**
* @param contextualGroundingPolicyConfig Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
*
* @return builder
*
*/
public Builder contextualGroundingPolicyConfig(@Nullable Output contextualGroundingPolicyConfig) {
$.contextualGroundingPolicyConfig = contextualGroundingPolicyConfig;
return this;
}
/**
* @param contextualGroundingPolicyConfig Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
*
* @return builder
*
*/
public Builder contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfigArgs contextualGroundingPolicyConfig) {
return contextualGroundingPolicyConfig(Output.of(contextualGroundingPolicyConfig));
}
/**
* @param description Description of the guardrail or its version.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description Description of the guardrail or its version.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param kmsKeyArn The KMS key with which the guardrail was encrypted at rest.
*
* @return builder
*
*/
public Builder kmsKeyArn(@Nullable Output kmsKeyArn) {
$.kmsKeyArn = kmsKeyArn;
return this;
}
/**
* @param kmsKeyArn The KMS key with which the guardrail was encrypted at rest.
*
* @return builder
*
*/
public Builder kmsKeyArn(String kmsKeyArn) {
return kmsKeyArn(Output.of(kmsKeyArn));
}
/**
* @param name Name of the guardrail.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Name of the guardrail.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param sensitiveInformationPolicyConfig Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
*
* @return builder
*
*/
public Builder sensitiveInformationPolicyConfig(@Nullable Output sensitiveInformationPolicyConfig) {
$.sensitiveInformationPolicyConfig = sensitiveInformationPolicyConfig;
return this;
}
/**
* @param sensitiveInformationPolicyConfig Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
*
* @return builder
*
*/
public Builder sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfigArgs sensitiveInformationPolicyConfig) {
return sensitiveInformationPolicyConfig(Output.of(sensitiveInformationPolicyConfig));
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
public Builder timeouts(@Nullable Output timeouts) {
$.timeouts = timeouts;
return this;
}
public Builder timeouts(GuardrailTimeoutsArgs timeouts) {
return timeouts(Output.of(timeouts));
}
/**
* @param topicPolicyConfig Topic policy config for a guardrail. See Topic Policy Config for more information.
*
* @return builder
*
*/
public Builder topicPolicyConfig(@Nullable Output topicPolicyConfig) {
$.topicPolicyConfig = topicPolicyConfig;
return this;
}
/**
* @param topicPolicyConfig Topic policy config for a guardrail. See Topic Policy Config for more information.
*
* @return builder
*
*/
public Builder topicPolicyConfig(GuardrailTopicPolicyConfigArgs topicPolicyConfig) {
return topicPolicyConfig(Output.of(topicPolicyConfig));
}
/**
* @param wordPolicyConfig Word policy config for a guardrail. See Word Policy Config for more information.
*
* @return builder
*
*/
public Builder wordPolicyConfig(@Nullable Output wordPolicyConfig) {
$.wordPolicyConfig = wordPolicyConfig;
return this;
}
/**
* @param wordPolicyConfig Word policy config for a guardrail. See Word Policy Config for more information.
*
* @return builder
*
*/
public Builder wordPolicyConfig(GuardrailWordPolicyConfigArgs wordPolicyConfig) {
return wordPolicyConfig(Output.of(wordPolicyConfig));
}
public GuardrailArgs build() {
if ($.blockedInputMessaging == null) {
throw new MissingRequiredPropertyException("GuardrailArgs", "blockedInputMessaging");
}
if ($.blockedOutputsMessaging == null) {
throw new MissingRequiredPropertyException("GuardrailArgs", "blockedOutputsMessaging");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy