DomainSamlOptions class
Manages SAML authentication options for an AWS OpenSearch Domain.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const example = new aws.opensearch.Domain("example", {
clusterConfig: {
instanceType: "r4.large.search",
},
snapshotOptions: {
automatedSnapshotStartHour: 23,
},
domainName: "example",
engineVersion: "OpenSearch_1.1",
tags: {
Domain: "TestDomain",
},
});
const exampleDomainSamlOptions = new aws.opensearch.DomainSamlOptions("example", {
samlOptions: {
idp: {
entityId: "https://example.com",
metadataContent: std.file({
input: "./saml-metadata.xml",
}).then(invoke => invoke.result),
},
enabled: true,
},
domainName: example.domainName,
});
import pulumi
import pulumi_aws as aws
import pulumi_std as std
example = aws.opensearch.Domain("example",
cluster_config={
"instance_type": "r4.large.search",
},
snapshot_options={
"automated_snapshot_start_hour": 23,
},
domain_name="example",
engine_version="OpenSearch_1.1",
tags={
"Domain": "TestDomain",
})
example_domain_saml_options = aws.opensearch.DomainSamlOptions("example",
saml_options={
"idp": {
"entity_id": "https://example.com",
"metadata_content": std.file(input="./saml-metadata.xml").result,
},
"enabled": True,
},
domain_name=example.domain_name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var example = new Aws.OpenSearch.Domain("example", new()
{
ClusterConfig = new Aws.OpenSearch.Inputs.DomainClusterConfigArgs
{
InstanceType = "r4.large.search",
},
SnapshotOptions = new Aws.OpenSearch.Inputs.DomainSnapshotOptionsArgs
{
AutomatedSnapshotStartHour = 23,
},
DomainName = "example",
EngineVersion = "OpenSearch_1.1",
Tags =
{
{ "Domain", "TestDomain" },
},
});
var exampleDomainSamlOptions = new Aws.OpenSearch.DomainSamlOptions("example", new()
{
SamlOptions = new Aws.OpenSearch.Inputs.DomainSamlOptionsSamlOptionsArgs
{
Idp = new Aws.OpenSearch.Inputs.DomainSamlOptionsSamlOptionsIdpArgs
{
EntityId = "https://example.com",
MetadataContent = Std.File.Invoke(new()
{
Input = "./saml-metadata.xml",
}).Apply(invoke => invoke.Result),
},
Enabled = true,
},
DomainName = example.DomainName,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearch"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := opensearch.NewDomain(ctx, "example", &opensearch.DomainArgs{
ClusterConfig: &opensearch.DomainClusterConfigArgs{
InstanceType: pulumi.String("r4.large.search"),
},
SnapshotOptions: &opensearch.DomainSnapshotOptionsArgs{
AutomatedSnapshotStartHour: pulumi.Int(23),
},
DomainName: pulumi.String("example"),
EngineVersion: pulumi.String("OpenSearch_1.1"),
Tags: pulumi.StringMap{
"Domain": pulumi.String("TestDomain"),
},
})
if err != nil {
return err
}
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "./saml-metadata.xml",
}, nil)
if err != nil {
return err
}
_, err = opensearch.NewDomainSamlOptions(ctx, "example", &opensearch.DomainSamlOptionsArgs{
SamlOptions: &opensearch.DomainSamlOptionsSamlOptionsArgs{
Idp: &opensearch.DomainSamlOptionsSamlOptionsIdpArgs{
EntityId: pulumi.String("https://example.com"),
MetadataContent: pulumi.String(invokeFile.Result),
},
Enabled: pulumi.Bool(true),
},
DomainName: example.DomainName,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
std = {
source = "pulumi/std"
}
}
}
resource "aws_opensearch_domain" "example" {
cluster_config = {
instance_type = "r4.large.search"
}
snapshot_options = {
automated_snapshot_start_hour = 23
}
domain_name = "example"
engine_version = "OpenSearch_1.1"
tags = {
"Domain" = "TestDomain"
}
}
resource "aws_opensearch_domainsamloptions" "example" {
saml_options = {
idp = {
entity_id = "https://example.com"
metadata_content = file("./saml-metadata.xml")
}
enabled = true
}
domain_name = aws_opensearch_domain.example.domain_name
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearch.Domain;
import com.pulumi.aws.opensearch.DomainArgs;
import com.pulumi.aws.opensearch.inputs.DomainClusterConfigArgs;
import com.pulumi.aws.opensearch.inputs.DomainSnapshotOptionsArgs;
import com.pulumi.aws.opensearch.DomainSamlOptions;
import com.pulumi.aws.opensearch.DomainSamlOptionsArgs;
import com.pulumi.aws.opensearch.inputs.DomainSamlOptionsSamlOptionsArgs;
import com.pulumi.aws.opensearch.inputs.DomainSamlOptionsSamlOptionsIdpArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Domain("example", DomainArgs.builder()
.clusterConfig(DomainClusterConfigArgs.builder()
.instanceType("r4.large.search")
.build())
.snapshotOptions(DomainSnapshotOptionsArgs.builder()
.automatedSnapshotStartHour(23)
.build())
.domainName("example")
.engineVersion("OpenSearch_1.1")
.tags(Map.of("Domain", "TestDomain"))
.build());
var exampleDomainSamlOptions = new DomainSamlOptions("exampleDomainSamlOptions", DomainSamlOptionsArgs.builder()
.samlOptions(DomainSamlOptionsSamlOptionsArgs.builder()
.idp(DomainSamlOptionsSamlOptionsIdpArgs.builder()
.entityId("https://example.com")
.metadataContent(StdFunctions.file(FileArgs.builder()
.input("./saml-metadata.xml")
.build()).result())
.build())
.enabled(true)
.build())
.domainName(example.domainName())
.build());
}
}
resources:
example:
type: aws:opensearch:Domain
properties:
clusterConfig:
instanceType: r4.large.search
snapshotOptions:
automatedSnapshotStartHour: 23
domainName: example
engineVersion: OpenSearch_1.1
tags:
Domain: TestDomain
exampleDomainSamlOptions:
type: aws:opensearch:DomainSamlOptions
name: example
properties:
samlOptions:
idp:
entityId: https://example.com
metadataContent:
fn::invoke:
function: std:file
arguments:
input: ./saml-metadata.xml
return: result
enabled: true
domainName: ${example.domainName}
Import
Using pulumi import, import OpenSearch domains using the domainName. For example:
$ pulumi import aws:opensearch/domainSamlOptions:DomainSamlOptions example domain_name
Constructors
- DomainSamlOptions(String name, {DomainSamlOptionsArgs? args, CustomResourceOptions? options})
-
Creates a new DomainSamlOptions.
nameThe Pulumi resource name.argsArguments used to configure this DomainSamlOptions. The set of arguments for DomainSamlOptions.optionsResource options controlling this resource's behavior. - DomainSamlOptions.reference(String urn)
- Creates a typed reference to an existing DomainSamlOptions resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainName
↔ Output<
String> -
Name of the domain.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
samlOptions
↔ Output<
DomainSamlOptionsSamlOptions?> -
SAML authentication options for an AWS OpenSearch Domain.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {DomainSamlOptionsState? state, CustomResourceOptions? options}) → DomainSamlOptions -
Gets an existing DomainSamlOptions resource's state with the given
nameandid.