pulumi-aws-native 1.38.0a1761284362__py3-none-any.whl → 1.39.0a1762409198__py3-none-any.whl

pulumi_aws_native/s3vectors/_enums.py

@@ -0,0 +1,39 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import pulumi
+from enum import Enum
+
+__all__ = [
+    'IndexDataType',
+    'IndexDistanceMetric',
+    'VectorBucketEncryptionConfigurationSseType',
+]
+
+
+@pulumi.type_token("aws-native:s3vectors:IndexDataType")
+class IndexDataType(_builtins.str, Enum):
+    """
+    The data type of the vectors to be inserted into the vector index.
+    """
+    FLOAT32 = "float32"
+
+
+@pulumi.type_token("aws-native:s3vectors:IndexDistanceMetric")
+class IndexDistanceMetric(_builtins.str, Enum):
+    """
+    The distance metric to be used for similarity search.
+    """
+    COSINE = "cosine"
+    EUCLIDEAN = "euclidean"
+
+
+@pulumi.type_token("aws-native:s3vectors:VectorBucketEncryptionConfigurationSseType")
+class VectorBucketEncryptionConfigurationSseType(_builtins.str, Enum):
+    """
+    The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+    """
+    AES256 = "AES256"
+    AWSKMS = "aws:kms"

pulumi_aws_native/s3vectors/_inputs.py

@@ -0,0 +1,138 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from ._enums import *
+
+__all__ = [
+    'IndexMetadataConfigurationArgs',
+    'IndexMetadataConfigurationArgsDict',
+    'VectorBucketEncryptionConfigurationArgs',
+    'VectorBucketEncryptionConfigurationArgsDict',
+    'VectorBucketPolicyPolicyArgs',
+    'VectorBucketPolicyPolicyArgsDict',
+]
+
+MYPY = False
+
+if not MYPY:
+    class IndexMetadataConfigurationArgsDict(TypedDict):
+        """
+        The metadata configuration for the vector index.
+        """
+        non_filterable_metadata_keys: NotRequired[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]
+        """
+        Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+        """
+elif False:
+    IndexMetadataConfigurationArgsDict: TypeAlias = Mapping[str, Any]
+
+@pulumi.input_type
+class IndexMetadataConfigurationArgs:
+    def __init__(__self__, *,
+                 non_filterable_metadata_keys: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]] = None):
+        """
+        The metadata configuration for the vector index.
+        :param pulumi.Input[Sequence[pulumi.Input[_builtins.str]]] non_filterable_metadata_keys: Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+        """
+        if non_filterable_metadata_keys is not None:
+            pulumi.set(__self__, "non_filterable_metadata_keys", non_filterable_metadata_keys)
+
+    @_builtins.property
+    @pulumi.getter(name="nonFilterableMetadataKeys")
+    def non_filterable_metadata_keys(self) -> Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]:
+        """
+        Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys cannot be used as query filters. Non-filterable metadata keys can be retrieved but cannot be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
+        """
+        return pulumi.get(self, "non_filterable_metadata_keys")
+
+    @non_filterable_metadata_keys.setter
+    def non_filterable_metadata_keys(self, value: Optional[pulumi.Input[Sequence[pulumi.Input[_builtins.str]]]]):
+        pulumi.set(self, "non_filterable_metadata_keys", value)
+
+
+if not MYPY:
+    class VectorBucketEncryptionConfigurationArgsDict(TypedDict):
+        """
+        The encryption configuration for the vector bucket.
+        """
+        kms_key_arn: NotRequired[pulumi.Input[_builtins.str]]
+        """
+        AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
+        """
+        sse_type: NotRequired[pulumi.Input['VectorBucketEncryptionConfigurationSseType']]
+        """
+        The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+        """
+elif False:
+    VectorBucketEncryptionConfigurationArgsDict: TypeAlias = Mapping[str, Any]
+
+@pulumi.input_type
+class VectorBucketEncryptionConfigurationArgs:
+    def __init__(__self__, *,
+                 kms_key_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                 sse_type: Optional[pulumi.Input['VectorBucketEncryptionConfigurationSseType']] = None):
+        """
+        The encryption configuration for the vector bucket.
+        :param pulumi.Input[_builtins.str] kms_key_arn: AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
+        :param pulumi.Input['VectorBucketEncryptionConfigurationSseType'] sse_type: The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+        """
+        if kms_key_arn is not None:
+            pulumi.set(__self__, "kms_key_arn", kms_key_arn)
+        if sse_type is not None:
+            pulumi.set(__self__, "sse_type", sse_type)
+
+    @_builtins.property
+    @pulumi.getter(name="kmsKeyArn")
+    def kms_key_arn(self) -> Optional[pulumi.Input[_builtins.str]]:
+        """
+        AWS Key Management Service (KMS) customer managed key ID to use for the encryption configuration. This parameter is allowed if and only if sseType is set to aws:kms
+        """
+        return pulumi.get(self, "kms_key_arn")
+
+    @kms_key_arn.setter
+    def kms_key_arn(self, value: Optional[pulumi.Input[_builtins.str]]):
+        pulumi.set(self, "kms_key_arn", value)
+
+    @_builtins.property
+    @pulumi.getter(name="sseType")
+    def sse_type(self) -> Optional[pulumi.Input['VectorBucketEncryptionConfigurationSseType']]:
+        """
+        The server-side encryption type to use for the encryption configuration of the vector bucket. By default, if you don't specify, all new vectors in Amazon S3 vector buckets use server-side encryption with Amazon S3 managed keys (SSE-S3), specifically AES256.
+        """
+        return pulumi.get(self, "sse_type")
+
+    @sse_type.setter
+    def sse_type(self, value: Optional[pulumi.Input['VectorBucketEncryptionConfigurationSseType']]):
+        pulumi.set(self, "sse_type", value)
+
+
+if not MYPY:
+    class VectorBucketPolicyPolicyArgsDict(TypedDict):
+        """
+        A policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
+        """
+        pass
+elif False:
+    VectorBucketPolicyPolicyArgsDict: TypeAlias = Mapping[str, Any]
+
+@pulumi.input_type
+class VectorBucketPolicyPolicyArgs:
+    def __init__(__self__):
+        """
+        A policy document containing permissions to add to the specified vector bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
+        """
+        pass
+
+

pulumi_aws_native/s3vectors/get_index.py

@@ -0,0 +1,99 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = [
+    'GetIndexResult',
+    'AwaitableGetIndexResult',
+    'get_index',
+    'get_index_output',
+]
+
+@pulumi.output_type
+class GetIndexResult:
+    def __init__(__self__, creation_time=None, index_arn=None):
+        if creation_time and not isinstance(creation_time, str):
+            raise TypeError("Expected argument 'creation_time' to be a str")
+        pulumi.set(__self__, "creation_time", creation_time)
+        if index_arn and not isinstance(index_arn, str):
+            raise TypeError("Expected argument 'index_arn' to be a str")
+        pulumi.set(__self__, "index_arn", index_arn)
+
+    @_builtins.property
+    @pulumi.getter(name="creationTime")
+    def creation_time(self) -> Optional[_builtins.str]:
+        """
+        Returns the date and time when the vector index was created.
+
+        Example: `2024-12-21T10:30:00Z`
+        """
+        return pulumi.get(self, "creation_time")
+
+    @_builtins.property
+    @pulumi.getter(name="indexArn")
+    def index_arn(self) -> Optional[_builtins.str]:
+        """
+        Returns the Amazon Resource Name (ARN) of the specified index.
+
+        Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
+        """
+        return pulumi.get(self, "index_arn")
+
+
+class AwaitableGetIndexResult(GetIndexResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetIndexResult(
+            creation_time=self.creation_time,
+            index_arn=self.index_arn)
+
+
+def get_index(index_arn: Optional[_builtins.str] = None,
+              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetIndexResult:
+    """
+    Resource Type definition for AWS::S3Vectors::Index
+
+
+    :param _builtins.str index_arn: Returns the Amazon Resource Name (ARN) of the specified index.
+           
+           Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
+    """
+    __args__ = dict()
+    __args__['indexArn'] = index_arn
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('aws-native:s3vectors:getIndex', __args__, opts=opts, typ=GetIndexResult).value
+
+    return AwaitableGetIndexResult(
+        creation_time=pulumi.get(__ret__, 'creation_time'),
+        index_arn=pulumi.get(__ret__, 'index_arn'))
+def get_index_output(index_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                     opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetIndexResult]:
+    """
+    Resource Type definition for AWS::S3Vectors::Index
+
+
+    :param _builtins.str index_arn: Returns the Amazon Resource Name (ARN) of the specified index.
+           
+           Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket/index/my-index`
+    """
+    __args__ = dict()
+    __args__['indexArn'] = index_arn
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('aws-native:s3vectors:getIndex', __args__, opts=opts, typ=GetIndexResult)
+    return __ret__.apply(lambda __response__: GetIndexResult(
+        creation_time=pulumi.get(__response__, 'creation_time'),
+        index_arn=pulumi.get(__response__, 'index_arn')))

pulumi_aws_native/s3vectors/get_vector_bucket.py

@@ -0,0 +1,99 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = [
+    'GetVectorBucketResult',
+    'AwaitableGetVectorBucketResult',
+    'get_vector_bucket',
+    'get_vector_bucket_output',
+]
+
+@pulumi.output_type
+class GetVectorBucketResult:
+    def __init__(__self__, creation_time=None, vector_bucket_arn=None):
+        if creation_time and not isinstance(creation_time, str):
+            raise TypeError("Expected argument 'creation_time' to be a str")
+        pulumi.set(__self__, "creation_time", creation_time)
+        if vector_bucket_arn and not isinstance(vector_bucket_arn, str):
+            raise TypeError("Expected argument 'vector_bucket_arn' to be a str")
+        pulumi.set(__self__, "vector_bucket_arn", vector_bucket_arn)
+
+    @_builtins.property
+    @pulumi.getter(name="creationTime")
+    def creation_time(self) -> Optional[_builtins.str]:
+        """
+        Returns the date and time when the vector bucket was created.
+
+        Example: `2024-12-21T10:30:00Z`
+        """
+        return pulumi.get(self, "creation_time")
+
+    @_builtins.property
+    @pulumi.getter(name="vectorBucketArn")
+    def vector_bucket_arn(self) -> Optional[_builtins.str]:
+        """
+        Returns the Amazon Resource Name (ARN) of the specified vector bucket.
+
+        Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`
+        """
+        return pulumi.get(self, "vector_bucket_arn")
+
+
+class AwaitableGetVectorBucketResult(GetVectorBucketResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVectorBucketResult(
+            creation_time=self.creation_time,
+            vector_bucket_arn=self.vector_bucket_arn)
+
+
+def get_vector_bucket(vector_bucket_arn: Optional[_builtins.str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetVectorBucketResult:
+    """
+    Resource Type definition for AWS::S3Vectors::VectorBucket
+
+
+    :param _builtins.str vector_bucket_arn: Returns the Amazon Resource Name (ARN) of the specified vector bucket.
+           
+           Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`
+    """
+    __args__ = dict()
+    __args__['vectorBucketArn'] = vector_bucket_arn
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('aws-native:s3vectors:getVectorBucket', __args__, opts=opts, typ=GetVectorBucketResult).value
+
+    return AwaitableGetVectorBucketResult(
+        creation_time=pulumi.get(__ret__, 'creation_time'),
+        vector_bucket_arn=pulumi.get(__ret__, 'vector_bucket_arn'))
+def get_vector_bucket_output(vector_bucket_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                             opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetVectorBucketResult]:
+    """
+    Resource Type definition for AWS::S3Vectors::VectorBucket
+
+
+    :param _builtins.str vector_bucket_arn: Returns the Amazon Resource Name (ARN) of the specified vector bucket.
+           
+           Example: `arn:aws:s3vectors:us-east-1:123456789012:bucket/amzn-s3-demo-vector-bucket`
+    """
+    __args__ = dict()
+    __args__['vectorBucketArn'] = vector_bucket_arn
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('aws-native:s3vectors:getVectorBucket', __args__, opts=opts, typ=GetVectorBucketResult)
+    return __ret__.apply(lambda __response__: GetVectorBucketResult(
+        creation_time=pulumi.get(__response__, 'creation_time'),
+        vector_bucket_arn=pulumi.get(__response__, 'vector_bucket_arn')))

pulumi_aws_native/s3vectors/get_vector_bucket_policy.py

@@ -0,0 +1,78 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+from . import outputs
+
+__all__ = [
+    'GetVectorBucketPolicyResult',
+    'AwaitableGetVectorBucketPolicyResult',
+    'get_vector_bucket_policy',
+    'get_vector_bucket_policy_output',
+]
+
+@pulumi.output_type
+class GetVectorBucketPolicyResult:
+    def __init__(__self__, policy=None):
+        if policy and not isinstance(policy, dict):
+            raise TypeError("Expected argument 'policy' to be a dict")
+        pulumi.set(__self__, "policy", policy)
+
+    @_builtins.property
+    @pulumi.getter
+    def policy(self) -> Optional['outputs.VectorBucketPolicyPolicy']:
+        """
+        A policy document containing permissions to add to the specified vector bucket. In IAM , you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM .
+        """
+        return pulumi.get(self, "policy")
+
+
+class AwaitableGetVectorBucketPolicyResult(GetVectorBucketPolicyResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetVectorBucketPolicyResult(
+            policy=self.policy)
+
+
+def get_vector_bucket_policy(vector_bucket_arn: Optional[_builtins.str] = None,
+                             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetVectorBucketPolicyResult:
+    """
+    Resource Type definition for AWS::S3Vectors::VectorBucketPolicy
+
+
+    :param _builtins.str vector_bucket_arn: The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
+    """
+    __args__ = dict()
+    __args__['vectorBucketArn'] = vector_bucket_arn
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('aws-native:s3vectors:getVectorBucketPolicy', __args__, opts=opts, typ=GetVectorBucketPolicyResult).value
+
+    return AwaitableGetVectorBucketPolicyResult(
+        policy=pulumi.get(__ret__, 'policy'))
+def get_vector_bucket_policy_output(vector_bucket_arn: Optional[pulumi.Input[_builtins.str]] = None,
+                                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetVectorBucketPolicyResult]:
+    """
+    Resource Type definition for AWS::S3Vectors::VectorBucketPolicy
+
+
+    :param _builtins.str vector_bucket_arn: The Amazon Resource Name (ARN) of the S3 vector bucket to which the policy applies.
+    """
+    __args__ = dict()
+    __args__['vectorBucketArn'] = vector_bucket_arn
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('aws-native:s3vectors:getVectorBucketPolicy', __args__, opts=opts, typ=GetVectorBucketPolicyResult)
+    return __ret__.apply(lambda __response__: GetVectorBucketPolicyResult(
+        policy=pulumi.get(__response__, 'policy')))