Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. bedrock
  5. Prompt

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.bedrock.Prompt

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Bedrock::Prompt Resource Type

    Create Prompt Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Prompt(name: string, args?: PromptArgs, opts?: CustomResourceOptions);
    @overload
def Prompt(resource_name: str,
           args: Optional[PromptArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Prompt(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           customer_encryption_key_arn: Optional[str] = None,
           default_variant: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           variants: Optional[Sequence[PromptVariantArgs]] = None)
    func NewPrompt(ctx *Context, name string, args *PromptArgs, opts ...ResourceOption) (*Prompt, error)
    public Prompt(string name, PromptArgs? args = null, CustomResourceOptions? opts = null)
    public Prompt(String name, PromptArgs args)
public Prompt(String name, PromptArgs args, CustomResourceOptions options)

    type: aws-native:bedrock:Prompt
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PromptArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Prompt Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Prompt resource accepts the following input properties:

    CustomerEncryptionKeyArn string
    A KMS key ARN
    DefaultVariant string
    Name for a variant.
    Description string
    Name for a prompt resource.
    Name string
    Name for a prompt resource.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    Variants List<Pulumi.AwsNative.Bedrock.Inputs.PromptVariant>
    List of prompt variants
    CustomerEncryptionKeyArn string
    A KMS key ARN
    DefaultVariant string
    Name for a variant.
    Description string
    Name for a prompt resource.
    Name string
    Name for a prompt resource.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    Variants []PromptVariantArgs
    List of prompt variants
    customerEncryptionKeyArn String
    A KMS key ARN
    defaultVariant String
    Name for a variant.
    description String
    Name for a prompt resource.
    name String
    Name for a prompt resource.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    variants List<PromptVariant>
    List of prompt variants
    customerEncryptionKeyArn string
    A KMS key ARN
    defaultVariant string
    Name for a variant.
    description string
    Name for a prompt resource.
    name string
    Name for a prompt resource.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    variants PromptVariant[]
    List of prompt variants
    customer_encryption_key_arn str
    A KMS key ARN
    default_variant str
    Name for a variant.
    description str
    Name for a prompt resource.
    name str
    Name for a prompt resource.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    variants Sequence[PromptVariantArgs]
    List of prompt variants
    customerEncryptionKeyArn String
    A KMS key ARN
    defaultVariant String
    Name for a variant.
    description String
    Name for a prompt resource.
    name String
    Name for a prompt resource.
    tags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    variants List<Property Map>
    List of prompt variants

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Prompt resource produces the following output properties:

    Arn string
    ARN of a prompt resource possibly with a version
    AwsId string
    Identifier for a Prompt
    CreatedAt string
    Time Stamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Time Stamp.
    Version string
    Draft Version.
    Arn string
    ARN of a prompt resource possibly with a version
    AwsId string
    Identifier for a Prompt
    CreatedAt string
    Time Stamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    Time Stamp.
    Version string
    Draft Version.
    arn String
    ARN of a prompt resource possibly with a version
    awsId String
    Identifier for a Prompt
    createdAt String
    Time Stamp.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Time Stamp.
    version String
    Draft Version.
    arn string
    ARN of a prompt resource possibly with a version
    awsId string
    Identifier for a Prompt
    createdAt string
    Time Stamp.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    Time Stamp.
    version string
    Draft Version.
    arn str
    ARN of a prompt resource possibly with a version
    aws_id str
    Identifier for a Prompt
    created_at str
    Time Stamp.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    Time Stamp.
    version str
    Draft Version.
    arn String
    ARN of a prompt resource possibly with a version
    awsId String
    Identifier for a Prompt
    createdAt String
    Time Stamp.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    Time Stamp.
    version String
    Draft Version.

    Supporting Types

    PromptInferenceConfigurationProperties, PromptInferenceConfigurationPropertiesArgs

    PromptInputVariable, PromptInputVariableArgs

    Name string
    Name for an input variable
    Name string
    Name for an input variable
    name String
    Name for an input variable
    name string
    Name for an input variable
    name str
    Name for an input variable
    name String
    Name for an input variable

    PromptModelInferenceConfiguration, PromptModelInferenceConfigurationArgs

    MaxTokens double
    Maximum length of output
    StopSequences List<string>
    List of stop sequences
    Temperature double
    Controls randomness, higher values increase diversity
    TopK double
    Sample from the k most likely next tokens
    TopP double
    Cumulative probability cutoff for token selection
    MaxTokens float64
    Maximum length of output
    StopSequences []string
    List of stop sequences
    Temperature float64
    Controls randomness, higher values increase diversity
    TopK float64
    Sample from the k most likely next tokens
    TopP float64
    Cumulative probability cutoff for token selection
    maxTokens Double
    Maximum length of output
    stopSequences List<String>
    List of stop sequences
    temperature Double
    Controls randomness, higher values increase diversity
    topK Double
    Sample from the k most likely next tokens
    topP Double
    Cumulative probability cutoff for token selection
    maxTokens number
    Maximum length of output
    stopSequences string[]
    List of stop sequences
    temperature number
    Controls randomness, higher values increase diversity
    topK number
    Sample from the k most likely next tokens
    topP number
    Cumulative probability cutoff for token selection
    max_tokens float
    Maximum length of output
    stop_sequences Sequence[str]
    List of stop sequences
    temperature float
    Controls randomness, higher values increase diversity
    top_k float
    Sample from the k most likely next tokens
    top_p float
    Cumulative probability cutoff for token selection
    maxTokens Number
    Maximum length of output
    stopSequences List<String>
    List of stop sequences
    temperature Number
    Controls randomness, higher values increase diversity
    topK Number
    Sample from the k most likely next tokens
    topP Number
    Cumulative probability cutoff for token selection

    PromptTemplateConfigurationProperties, PromptTemplateConfigurationPropertiesArgs

    PromptTemplateType, PromptTemplateTypeArgs

    Text
    TEXT
    PromptTemplateTypeText
    TEXT
    Text
    TEXT
    Text
    TEXT
    TEXT
    TEXT
    "TEXT"
    TEXT

    PromptTextPromptTemplateConfiguration, PromptTextPromptTemplateConfigurationArgs

    InputVariables []PromptInputVariable
    List of input variables
    Text string
    Prompt content for String prompt template
    TextS3Location PromptTextS3Location
    inputVariables List<PromptInputVariable>
    List of input variables
    text String
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    inputVariables PromptInputVariable[]
    List of input variables
    text string
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    input_variables Sequence[PromptInputVariable]
    List of input variables
    text str
    Prompt content for String prompt template
    text_s3_location PromptTextS3Location
    inputVariables List<Property Map>
    List of input variables
    text String
    Prompt content for String prompt template
    textS3Location Property Map

    PromptTextS3Location, PromptTextS3LocationArgs

    Bucket string
    A bucket in S3
    Key string
    A object key in S3
    Version string
    The version of the the S3 object to use
    Bucket string
    A bucket in S3
    Key string
    A object key in S3
    Version string
    The version of the the S3 object to use
    bucket String
    A bucket in S3
    key String
    A object key in S3
    version String
    The version of the the S3 object to use
    bucket string
    A bucket in S3
    key string
    A object key in S3
    version string
    The version of the the S3 object to use
    bucket str
    A bucket in S3
    key str
    A object key in S3
    version str
    The version of the the S3 object to use
    bucket String
    A bucket in S3
    key String
    A object key in S3
    version String
    The version of the the S3 object to use

    PromptVariant, PromptVariantArgs

    Name string
    Name for a variant.
    TemplateType Pulumi.AwsNative.Bedrock.PromptTemplateType
    The type of prompt template to use.
    InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    ModelId string
    ARN or name of a Bedrock model.
    TemplateConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    Name string
    Name for a variant.
    TemplateType PromptTemplateType
    The type of prompt template to use.
    InferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    ModelId string
    ARN or name of a Bedrock model.
    TemplateConfiguration PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    name String
    Name for a variant.
    templateType PromptTemplateType
    The type of prompt template to use.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    modelId String
    ARN or name of a Bedrock model.
    templateConfiguration PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    name string
    Name for a variant.
    templateType PromptTemplateType
    The type of prompt template to use.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    modelId string
    ARN or name of a Bedrock model.
    templateConfiguration PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    name str
    Name for a variant.
    template_type PromptTemplateType
    The type of prompt template to use.
    inference_configuration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    model_id str
    ARN or name of a Bedrock model.
    template_configuration PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    name String
    Name for a variant.
    templateType "TEXT"
    The type of prompt template to use.
    inferenceConfiguration Property Map
    Contains inference configurations for the prompt variant.
    modelId String
    ARN or name of a Bedrock model.
    templateConfiguration Property Map
    Contains configurations for the prompt template.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native