@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
103 lines • 3.73 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DomainSamlOptions = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages SAML authentication options for an AWS OpenSearch Domain.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* 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", {
* domainName: "example",
* engineVersion: "OpenSearch_1.1",
* clusterConfig: {
* instanceType: "r4.large.search",
* },
* snapshotOptions: {
* automatedSnapshotStartHour: 23,
* },
* tags: {
* Domain: "TestDomain",
* },
* });
* const exampleDomainSamlOptions = new aws.opensearch.DomainSamlOptions("example", {
* domainName: example.domainName,
* samlOptions: {
* enabled: true,
* idp: {
* entityId: "https://example.com",
* metadataContent: std.file({
* input: "./saml-metadata.xml",
* }).then(invoke => invoke.result),
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import OpenSearch domains using the `domain_name`. For example:
*
* ```sh
* $ pulumi import aws:opensearch/domainSamlOptions:DomainSamlOptions example domain_name
* ```
*/
class DomainSamlOptions extends pulumi.CustomResource {
/**
* Get an existing DomainSamlOptions resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new DomainSamlOptions(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DomainSamlOptions. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === DomainSamlOptions.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["domainName"] = state?.domainName;
resourceInputs["region"] = state?.region;
resourceInputs["samlOptions"] = state?.samlOptions;
}
else {
const args = argsOrState;
if (args?.domainName === undefined && !opts.urn) {
throw new Error("Missing required property 'domainName'");
}
resourceInputs["domainName"] = args?.domainName;
resourceInputs["region"] = args?.region;
resourceInputs["samlOptions"] = args?.samlOptions;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DomainSamlOptions.__pulumiType, name, resourceInputs, opts);
}
}
exports.DomainSamlOptions = DomainSamlOptions;
/** @internal */
DomainSamlOptions.__pulumiType = 'aws:opensearch/domainSamlOptions:DomainSamlOptions';
//# sourceMappingURL=domainSamlOptions.js.map