Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. AuthenticationProfile
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.redshift.AuthenticationProfile

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Creates a Redshift authentication profile

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.AuthenticationProfile("example", {
    authenticationProfileName: "example",
    authenticationProfileContent: JSON.stringify({
        AllowDBUserOverride: "1",
        Client_ID: "ExampleClientID",
        App_ID: "example",
    }),
});
Copy
import pulumi
import json
import pulumi_aws as aws

example = aws.redshift.AuthenticationProfile("example",
    authentication_profile_name="example",
    authentication_profile_content=json.dumps({
        "AllowDBUserOverride": "1",
        "Client_ID": "ExampleClientID",
        "App_ID": "example",
    }))
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"AllowDBUserOverride": "1",
			"Client_ID":           "ExampleClientID",
			"App_ID":              "example",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = redshift.NewAuthenticationProfile(ctx, "example", &redshift.AuthenticationProfileArgs{
			AuthenticationProfileName:    pulumi.String("example"),
			AuthenticationProfileContent: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.AuthenticationProfile("example", new()
    {
        AuthenticationProfileName = "example",
        AuthenticationProfileContent = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["AllowDBUserOverride"] = "1",
            ["Client_ID"] = "ExampleClientID",
            ["App_ID"] = "example",
        }),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.AuthenticationProfile;
import com.pulumi.aws.redshift.AuthenticationProfileArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 AuthenticationProfile("example", AuthenticationProfileArgs.builder()
            .authenticationProfileName("example")
            .authenticationProfileContent(serializeJson(
                jsonObject(
                    jsonProperty("AllowDBUserOverride", "1"),
                    jsonProperty("Client_ID", "ExampleClientID"),
                    jsonProperty("App_ID", "example")
                )))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:redshift:AuthenticationProfile
    properties:
      authenticationProfileName: example
      authenticationProfileContent:
        fn::toJSON:
          AllowDBUserOverride: '1'
          Client_ID: ExampleClientID
          App_ID: example
Copy

Create AuthenticationProfile Resource

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

Constructor syntax

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

@overload
def AuthenticationProfile(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          authentication_profile_content: Optional[str] = None,
                          authentication_profile_name: Optional[str] = None)
func NewAuthenticationProfile(ctx *Context, name string, args AuthenticationProfileArgs, opts ...ResourceOption) (*AuthenticationProfile, error)
public AuthenticationProfile(string name, AuthenticationProfileArgs args, CustomResourceOptions? opts = null)
public AuthenticationProfile(String name, AuthenticationProfileArgs args)
public AuthenticationProfile(String name, AuthenticationProfileArgs args, CustomResourceOptions options)

type: aws:redshift:AuthenticationProfile
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 This property is required. AuthenticationProfileArgs
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 This property is required. AuthenticationProfileArgs
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 This property is required. AuthenticationProfileArgs
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 This property is required. AuthenticationProfileArgs
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. AuthenticationProfileArgs
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 authenticationProfileResource = new Aws.RedShift.AuthenticationProfile("authenticationProfileResource", new()
{
    AuthenticationProfileContent = "string",
    AuthenticationProfileName = "string",
});
Copy
example, err := redshift.NewAuthenticationProfile(ctx, "authenticationProfileResource", &redshift.AuthenticationProfileArgs{
	AuthenticationProfileContent: pulumi.String("string"),
	AuthenticationProfileName:    pulumi.String("string"),
})
Copy
var authenticationProfileResource = new AuthenticationProfile("authenticationProfileResource", AuthenticationProfileArgs.builder()
    .authenticationProfileContent("string")
    .authenticationProfileName("string")
    .build());
Copy
authentication_profile_resource = aws.redshift.AuthenticationProfile("authenticationProfileResource",
    authentication_profile_content="string",
    authentication_profile_name="string")
Copy
const authenticationProfileResource = new aws.redshift.AuthenticationProfile("authenticationProfileResource", {
    authenticationProfileContent: "string",
    authenticationProfileName: "string",
});
Copy
type: aws:redshift:AuthenticationProfile
properties:
    authenticationProfileContent: string
    authenticationProfileName: string
Copy

AuthenticationProfile 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 AuthenticationProfile resource accepts the following input properties:

AuthenticationProfileContent This property is required. string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
AuthenticationProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the authentication profile.
AuthenticationProfileContent This property is required. string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
AuthenticationProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the authentication profile.
authenticationProfileContent This property is required. String
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the authentication profile.
authenticationProfileContent This property is required. string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName
This property is required.
Changes to this property will trigger replacement.
string
The name of the authentication profile.
authentication_profile_content This property is required. str
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authentication_profile_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the authentication profile.
authenticationProfileContent This property is required. String
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName
This property is required.
Changes to this property will trigger replacement.
String
The name of the authentication profile.

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthenticationProfile 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 AuthenticationProfile Resource

Get an existing AuthenticationProfile 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?: AuthenticationProfileState, opts?: CustomResourceOptions): AuthenticationProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_profile_content: Optional[str] = None,
        authentication_profile_name: Optional[str] = None) -> AuthenticationProfile
func GetAuthenticationProfile(ctx *Context, name string, id IDInput, state *AuthenticationProfileState, opts ...ResourceOption) (*AuthenticationProfile, error)
public static AuthenticationProfile Get(string name, Input<string> id, AuthenticationProfileState? state, CustomResourceOptions? opts = null)
public static AuthenticationProfile get(String name, Output<String> id, AuthenticationProfileState state, CustomResourceOptions options)
resources:  _:    type: aws:redshift:AuthenticationProfile    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:
AuthenticationProfileContent string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
AuthenticationProfileName Changes to this property will trigger replacement. string
The name of the authentication profile.
AuthenticationProfileContent string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
AuthenticationProfileName Changes to this property will trigger replacement. string
The name of the authentication profile.
authenticationProfileContent String
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName Changes to this property will trigger replacement. String
The name of the authentication profile.
authenticationProfileContent string
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName Changes to this property will trigger replacement. string
The name of the authentication profile.
authentication_profile_content str
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authentication_profile_name Changes to this property will trigger replacement. str
The name of the authentication profile.
authenticationProfileContent String
The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
authenticationProfileName Changes to this property will trigger replacement. String
The name of the authentication profile.

Import

Using pulumi import, import Redshift Authentication by authentication_profile_name. For example:

$ pulumi import aws:redshift/authenticationProfile:AuthenticationProfile test example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws