1. Packages
  2. AWS Classic
  3. API Docs
  4. redshift
  5. AuthenticationProfile

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

aws.redshift.AuthenticationProfile

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

    Creates a Redshift authentication profile

    Example Usage

    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",
            }),
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    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",
        }))
    
    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",
        }),
    });
    
    resources:
      example:
        type: aws:redshift:AuthenticationProfile
        properties:
          authenticationProfileName: example
          authenticationProfileContent:
            fn::toJSON:
              AllowDBUserOverride: '1'
              Client_ID: ExampleClientID
              App_ID: example
    

    Create AuthenticationProfile Resource

    new AuthenticationProfile(name: string, args: AuthenticationProfileArgs, opts?: CustomResourceOptions);
    @overload
    def AuthenticationProfile(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              authentication_profile_content: Optional[str] = None,
                              authentication_profile_name: Optional[str] = None)
    @overload
    def AuthenticationProfile(resource_name: str,
                              args: AuthenticationProfileArgs,
                              opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args AuthenticationProfileArgs
    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 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 string
    The unique name of the resource.
    args AuthenticationProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthenticationProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthenticationProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The AuthenticationProfile resource accepts the following input properties:

    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 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 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 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 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 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 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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 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 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 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 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
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi