DomainServiceAccessPolicy class

Provides an CloudSearch domain service access policy resource.

The provider waits for the domain service access policy to become Active when applying a configuration.

Example Usage

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

const exampleDomain = new aws.cloudsearch.Domain("example", {name: "example-domain"});
const example = aws.iam.getPolicyDocument({
    statements: [{
        sid: "search_only",
        effect: "Allow",
        principals: [{
            type: "*",
            identifiers: ["*"],
        }],
        actions: [
            "cloudsearch:search",
            "cloudsearch:document",
        ],
        conditions: [{
            test: "IpAddress",
            variable: "aws:SourceIp",
            values: ["192.0.2.0/32"],
        }],
    }],
});
const exampleDomainServiceAccessPolicy = new aws.cloudsearch.DomainServiceAccessPolicy("example", {
    domainName: exampleDomain.id,
    accessPolicy: example.then(example => example.json),
});
import pulumi
import pulumi_aws as aws

example_domain = aws.cloudsearch.Domain("example", name="example-domain")
example = aws.iam.get_policy_document(statements=[{
    "sid": "search_only",
    "effect": "Allow",
    "principals": [{
        "type": "*",
        "identifiers": ["*"],
    }],
    "actions": [
        "cloudsearch:search",
        "cloudsearch:document",
    ],
    "conditions": [{
        "test": "IpAddress",
        "variable": "aws:SourceIp",
        "values": ["192.0.2.0/32"],
    }],
}])
example_domain_service_access_policy = aws.cloudsearch.DomainServiceAccessPolicy("example",
    domain_name=example_domain.id,
    access_policy=example.json)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var exampleDomain = new Aws.CloudSearch.Domain("example", new()
    {
        Name = "example-domain",
    });

    var example = Aws.Iam.GetPolicyDocument.Invoke(new()
    {
        Statements = new[]
        {
            new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
            {
                Sid = "search_only",
                Effect = "Allow",
                Principals = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
                    {
                        Type = "*",
                        Identifiers = new[]
                        {
                            "*",
                        },
                    },
                },
                Actions = new[]
                {
                    "cloudsearch:search",
                    "cloudsearch:document",
                },
                Conditions = new[]
                {
                    new Aws.Iam.Inputs.GetPolicyDocumentStatementConditionInputArgs
                    {
                        Test = "IpAddress",
                        Variable = "aws:SourceIp",
                        Values = new[]
                        {
                            "192.0.2.0/32",
                        },
                    },
                },
            },
        },
    });

    var exampleDomainServiceAccessPolicy = new Aws.CloudSearch.DomainServiceAccessPolicy("example", new()
    {
        DomainName = exampleDomain.Id,
        AccessPolicy = example.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudsearch"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDomain, err := cloudsearch.NewDomain(ctx, "example", &cloudsearch.DomainArgs{
			Name: pulumi.String("example-domain"),
		})
		if err != nil {
			return err
		}
		example, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
			Statements: []iam.GetPolicyDocumentStatement{
				{
					Sid:    pulumi.StringRef("search_only"),
					Effect: pulumi.StringRef("Allow"),
					Principals: []iam.GetPolicyDocumentStatementPrincipal{
						{
							Type: "*",
							Identifiers: []string{
								"*",
							},
						},
					},
					Actions: []string{
						"cloudsearch:search",
						"cloudsearch:document",
					},
					Conditions: []iam.GetPolicyDocumentStatementCondition{
						{
							Test:     "IpAddress",
							Variable: "aws:SourceIp",
							Values: []string{
								"192.0.2.0/32",
							},
						},
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = cloudsearch.NewDomainServiceAccessPolicy(ctx, "example", &cloudsearch.DomainServiceAccessPolicyArgs{
			DomainName:   exampleDomain.ID().ToIDOutput().ToStringOutput(),
			AccessPolicy: pulumi.String(example.Json),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getpolicydocument" "example" {
  statements {
    sid    = "search_only"
    effect = "Allow"
    principals {
      type        = "*"
      identifiers = ["*"]
    }
    actions = ["cloudsearch:search", "cloudsearch:document"]
    conditions {
      test     = "IpAddress"
      variable = "aws:SourceIp"
      values   = ["192.0.2.0/32"]
    }
  }
}

resource "aws_cloudsearch_domain" "example" {
  name = "example-domain"
}
resource "aws_cloudsearch_domainserviceaccesspolicy" "example" {
  domain_name   = aws_cloudsearch_domain.example.id
  access_policy = data.aws_iam_getpolicydocument.example.json
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.cloudsearch.Domain;
import com.pulumi.aws.cloudsearch.DomainArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
import com.pulumi.aws.cloudsearch.DomainServiceAccessPolicy;
import com.pulumi.aws.cloudsearch.DomainServiceAccessPolicyArgs;
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 exampleDomain = new Domain("exampleDomain", DomainArgs.builder()
            .name("example-domain")
            .build());

        final var example = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
            .statements(GetPolicyDocumentStatementArgs.builder()
                .sid("search_only")
                .effect("Allow")
                .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                    .type("*")
                    .identifiers("*")
                    .build())
                .actions(
                    "cloudsearch:search",
                    "cloudsearch:document")
                .conditions(GetPolicyDocumentStatementConditionArgs.builder()
                    .test("IpAddress")
                    .variable("aws:SourceIp")
                    .values("192.0.2.0/32")
                    .build())
                .build())
            .build());

        var exampleDomainServiceAccessPolicy = new DomainServiceAccessPolicy("exampleDomainServiceAccessPolicy", DomainServiceAccessPolicyArgs.builder()
            .domainName(exampleDomain.id())
            .accessPolicy(example.json())
            .build());

    }
}
resources:
  exampleDomain:
    type: aws:cloudsearch:Domain
    name: example
    properties:
      name: example-domain
  exampleDomainServiceAccessPolicy:
    type: aws:cloudsearch:DomainServiceAccessPolicy
    name: example
    properties:
      domainName: ${exampleDomain.id}
      accessPolicy: ${example.json}
variables:
  example:
    fn::invoke:
      function: aws:iam:getPolicyDocument
      arguments:
        statements:
          - sid: search_only
            effect: Allow
            principals:
              - type: '*'
                identifiers:
                  - '*'
            actions:
              - cloudsearch:search
              - cloudsearch:document
            conditions:
              - test: IpAddress
                variable: aws:SourceIp
                values:
                  - 192.0.2.0/32

Import

Using pulumi import, import CloudSearch domain service access policies using the domain name. For example:

$ pulumi import aws:cloudsearch/domainServiceAccessPolicy:DomainServiceAccessPolicy example example-domain

Constructors

DomainServiceAccessPolicy(String name, {DomainServiceAccessPolicyArgs? args, CustomResourceOptions? options})
Creates a new DomainServiceAccessPolicy. name The Pulumi resource name. args Arguments used to configure this DomainServiceAccessPolicy. The set of arguments for DomainServiceAccessPolicy. options Resource options controlling this resource's behavior.

Properties

accessPolicy ↔ Output<String>
The access rules you want to configure. These rules replace any existing rules. See the AWS documentation for details.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
The CloudSearch domain name the policy applies to.
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
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, {DomainServiceAccessPolicyState? state}) → DomainServiceAccessPolicy
Gets an existing DomainServiceAccessPolicy resource's state with the given name and id.