Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. AwsCredential
DataRobot v0.9.0 published on Tuesday, Apr 8, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.AwsCredential

Explore with Pulumi AI

DataRobot v0.9.0 published on Tuesday, Apr 8, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

AWS Credential

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as datarobot from "@datarobot/pulumi-datarobot";

const example = new datarobot.AwsCredential("example", {
    awsAccessKeyId: "example_access_key_id",
    awsSecretAccessKey: "example_secret_access_key",
    awsSessionToken: "example_session_token",
    description: "Description for the example AWS credential",
});
Copy
import pulumi
import pulumi_datarobot as datarobot

example = datarobot.AwsCredential("example",
    aws_access_key_id="example_access_key_id",
    aws_secret_access_key="example_secret_access_key",
    aws_session_token="example_session_token",
    description="Description for the example AWS credential")
Copy
package main

import (
	"github.com/datarobot-community/pulumi-datarobot/sdk/go/datarobot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datarobot.NewAwsCredential(ctx, "example", &datarobot.AwsCredentialArgs{
			AwsAccessKeyId:     pulumi.String("example_access_key_id"),
			AwsSecretAccessKey: pulumi.String("example_secret_access_key"),
			AwsSessionToken:    pulumi.String("example_session_token"),
			Description:        pulumi.String("Description for the example AWS credential"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datarobot = DataRobotPulumi.Datarobot;

return await Deployment.RunAsync(() => 
{
    var example = new Datarobot.AwsCredential("example", new()
    {
        AwsAccessKeyId = "example_access_key_id",
        AwsSecretAccessKey = "example_secret_access_key",
        AwsSessionToken = "example_session_token",
        Description = "Description for the example AWS credential",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datarobot.AwsCredential;
import com.pulumi.datarobot.AwsCredentialArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AwsCredential("example", AwsCredentialArgs.builder()
            .awsAccessKeyId("example_access_key_id")
            .awsSecretAccessKey("example_secret_access_key")
            .awsSessionToken("example_session_token")
            .description("Description for the example AWS credential")
            .build());

    }
}
Copy
resources:
  example:
    type: datarobot:AwsCredential
    properties:
      awsAccessKeyId: example_access_key_id
      awsSecretAccessKey: example_secret_access_key
      awsSessionToken: example_session_token
      description: Description for the example AWS credential
Copy

Create AwsCredential Resource

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

Constructor syntax

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

@overload
def AwsCredential(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  aws_access_key_id: Optional[str] = None,
                  aws_secret_access_key: Optional[str] = None,
                  aws_session_token: Optional[str] = None,
                  config_id: Optional[str] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None)
func NewAwsCredential(ctx *Context, name string, args *AwsCredentialArgs, opts ...ResourceOption) (*AwsCredential, error)
public AwsCredential(string name, AwsCredentialArgs? args = null, CustomResourceOptions? opts = null)
public AwsCredential(String name, AwsCredentialArgs args)
public AwsCredential(String name, AwsCredentialArgs args, CustomResourceOptions options)

type: datarobot:AwsCredential
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var awsCredentialResource = new Datarobot.AwsCredential("awsCredentialResource", new()
{
    AwsAccessKeyId = "string",
    AwsSecretAccessKey = "string",
    AwsSessionToken = "string",
    ConfigId = "string",
    Description = "string",
    Name = "string",
});
Copy
example, err := datarobot.NewAwsCredential(ctx, "awsCredentialResource", &datarobot.AwsCredentialArgs{
	AwsAccessKeyId:     pulumi.String("string"),
	AwsSecretAccessKey: pulumi.String("string"),
	AwsSessionToken:    pulumi.String("string"),
	ConfigId:           pulumi.String("string"),
	Description:        pulumi.String("string"),
	Name:               pulumi.String("string"),
})
Copy
var awsCredentialResource = new AwsCredential("awsCredentialResource", AwsCredentialArgs.builder()
    .awsAccessKeyId("string")
    .awsSecretAccessKey("string")
    .awsSessionToken("string")
    .configId("string")
    .description("string")
    .name("string")
    .build());
Copy
aws_credential_resource = datarobot.AwsCredential("awsCredentialResource",
    aws_access_key_id="string",
    aws_secret_access_key="string",
    aws_session_token="string",
    config_id="string",
    description="string",
    name="string")
Copy
const awsCredentialResource = new datarobot.AwsCredential("awsCredentialResource", {
    awsAccessKeyId: "string",
    awsSecretAccessKey: "string",
    awsSessionToken: "string",
    configId: "string",
    description: "string",
    name: "string",
});
Copy
type: datarobot:AwsCredential
properties:
    awsAccessKeyId: string
    awsSecretAccessKey: string
    awsSessionToken: string
    configId: string
    description: string
    name: string
Copy

AwsCredential Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AwsCredential resource accepts the following input properties:

AwsAccessKeyId string
The AWS Access Key ID.
AwsSecretAccessKey string
The AWS Secret Access Key.
AwsSessionToken string
The AWS Session Token.
ConfigId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
Description string
The description of the AWS Credential.
Name string
The name of the AWS Credential.
AwsAccessKeyId string
The AWS Access Key ID.
AwsSecretAccessKey string
The AWS Secret Access Key.
AwsSessionToken string
The AWS Session Token.
ConfigId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
Description string
The description of the AWS Credential.
Name string
The name of the AWS Credential.
awsAccessKeyId String
The AWS Access Key ID.
awsSecretAccessKey String
The AWS Secret Access Key.
awsSessionToken String
The AWS Session Token.
configId String
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description String
The description of the AWS Credential.
name String
The name of the AWS Credential.
awsAccessKeyId string
The AWS Access Key ID.
awsSecretAccessKey string
The AWS Secret Access Key.
awsSessionToken string
The AWS Session Token.
configId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description string
The description of the AWS Credential.
name string
The name of the AWS Credential.
aws_access_key_id str
The AWS Access Key ID.
aws_secret_access_key str
The AWS Secret Access Key.
aws_session_token str
The AWS Session Token.
config_id str
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description str
The description of the AWS Credential.
name str
The name of the AWS Credential.
awsAccessKeyId String
The AWS Access Key ID.
awsSecretAccessKey String
The AWS Secret Access Key.
awsSessionToken String
The AWS Session Token.
configId String
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description String
The description of the AWS Credential.
name String
The name of the AWS Credential.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AwsCredential Resource

Get an existing AwsCredential resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AwsCredentialState, opts?: CustomResourceOptions): AwsCredential
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_access_key_id: Optional[str] = None,
        aws_secret_access_key: Optional[str] = None,
        aws_session_token: Optional[str] = None,
        config_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> AwsCredential
func GetAwsCredential(ctx *Context, name string, id IDInput, state *AwsCredentialState, opts ...ResourceOption) (*AwsCredential, error)
public static AwsCredential Get(string name, Input<string> id, AwsCredentialState? state, CustomResourceOptions? opts = null)
public static AwsCredential get(String name, Output<String> id, AwsCredentialState state, CustomResourceOptions options)
resources:  _:    type: datarobot:AwsCredential    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AwsAccessKeyId string
The AWS Access Key ID.
AwsSecretAccessKey string
The AWS Secret Access Key.
AwsSessionToken string
The AWS Session Token.
ConfigId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
Description string
The description of the AWS Credential.
Name string
The name of the AWS Credential.
AwsAccessKeyId string
The AWS Access Key ID.
AwsSecretAccessKey string
The AWS Secret Access Key.
AwsSessionToken string
The AWS Session Token.
ConfigId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
Description string
The description of the AWS Credential.
Name string
The name of the AWS Credential.
awsAccessKeyId String
The AWS Access Key ID.
awsSecretAccessKey String
The AWS Secret Access Key.
awsSessionToken String
The AWS Session Token.
configId String
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description String
The description of the AWS Credential.
name String
The name of the AWS Credential.
awsAccessKeyId string
The AWS Access Key ID.
awsSecretAccessKey string
The AWS Secret Access Key.
awsSessionToken string
The AWS Session Token.
configId string
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description string
The description of the AWS Credential.
name string
The name of the AWS Credential.
aws_access_key_id str
The AWS Access Key ID.
aws_secret_access_key str
The AWS Secret Access Key.
aws_session_token str
The AWS Session Token.
config_id str
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description str
The description of the AWS Credential.
name str
The name of the AWS Credential.
awsAccessKeyId String
The AWS Access Key ID.
awsSecretAccessKey String
The AWS Secret Access Key.
awsSessionToken String
The AWS Session Token.
configId String
The ID of the saved shared secure configuration. If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
description String
The description of the AWS Credential.
name String
The name of the AWS Credential.

Package Details

Repository
datarobot datarobot-community/pulumi-datarobot
License
Apache-2.0
Notes
This Pulumi package is based on the datarobot Terraform Provider.
DataRobot v0.9.0 published on Tuesday, Apr 8, 2025 by DataRobot, Inc.
datarobot-community/pulumi-datarobot