We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource Type definition for AWS::OpenSearchServerless::AccessPolicy
Create AccessPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AccessPolicy(name: string, args: AccessPolicyArgs, opts?: CustomResourceOptions);@overload
def AccessPolicy(resource_name: str,
args: AccessPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AccessPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
policy: Optional[str] = None,
type: Optional[AccessPolicyType] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewAccessPolicy(ctx *Context, name string, args AccessPolicyArgs, opts ...ResourceOption) (*AccessPolicy, error)public AccessPolicy(string name, AccessPolicyArgs args, CustomResourceOptions? opts = null)
public AccessPolicy(String name, AccessPolicyArgs args)
public AccessPolicy(String name, AccessPolicyArgs args, CustomResourceOptions options)
type: aws-native:opensearchserverless:AccessPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_opensearchserverless_access_policy" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AccessPolicyArgs
- 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 AccessPolicyArgs
- 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 AccessPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AccessPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AccessPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AccessPolicy 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 AccessPolicy resource accepts the following input properties:
- Policy string
- The JSON policy document that is the content for the policy
- Type
Pulumi.
Aws Native. Open Search Serverless. Access Policy Type - The type of access policy. Currently the only option is
data. - Description string
- The description of the policy
- Name string
- The name of the policy
- Policy string
- The JSON policy document that is the content for the policy
- Type
Access
Policy Type - The type of access policy. Currently the only option is
data. - Description string
- The description of the policy
- Name string
- The name of the policy
- policy string
- The JSON policy document that is the content for the policy
- type "data"
- The type of access policy. Currently the only option is
data. - description string
- The description of the policy
- name string
- The name of the policy
- policy String
- The JSON policy document that is the content for the policy
- type
Access
Policy Type - The type of access policy. Currently the only option is
data. - description String
- The description of the policy
- name String
- The name of the policy
- policy string
- The JSON policy document that is the content for the policy
- type
Access
Policy Type - The type of access policy. Currently the only option is
data. - description string
- The description of the policy
- name string
- The name of the policy
- policy str
- The JSON policy document that is the content for the policy
- type
Access
Policy Type - The type of access policy. Currently the only option is
data. - description str
- The description of the policy
- name str
- The name of the policy
- policy String
- The JSON policy document that is the content for the policy
- type "data"
- The type of access policy. Currently the only option is
data. - description String
- The description of the policy
- name String
- The name of the policy
Outputs
All input properties are implicitly available as output properties. Additionally, the AccessPolicy 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 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 AccessPolicy Resource
Get an existing AccessPolicy 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>, opts?: CustomResourceOptions): AccessPolicy@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> AccessPolicyfunc GetAccessPolicy(ctx *Context, name string, id IDInput, state *AccessPolicyState, opts ...ResourceOption) (*AccessPolicy, error)public static AccessPolicy Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static AccessPolicy get(String name, Output<String> id, CustomResourceOptions options)resources: existingAccessPolicy: type: aws-native:opensearchserverless:AccessPolicy get: id: ${id}import {
to = aws-native_opensearchserverless_access_policy.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state AccessPolicyState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AccessPolicyType
The possible types for the access policy
| Name | Value |
|---|---|
| Data | data |
| Name | Value |
|---|---|
| Access | data |
| Value |
|---|
data |
| Name | Value |
|---|---|
| Data | data |
| Name | Value |
|---|---|
| Data | data |
| Name | Value |
|---|---|
| DATA | data |
| Value |
|---|
data |
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi