1. Packages
  2. AWS
  3. API Docs
  4. lb
  5. TrustStore
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.lb.TrustStore

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Provides a ELBv2 Trust Store for use with Application Load Balancer Listener resources.

    Example Usage

    Create TrustStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TrustStore(name: string, args: TrustStoreArgs, opts?: CustomResourceOptions);
    @overload
    def TrustStore(resource_name: str,
                   args: TrustStoreArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def TrustStore(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ca_certificates_bundle_s3_bucket: Optional[str] = None,
                   ca_certificates_bundle_s3_key: Optional[str] = None,
                   ca_certificates_bundle_s3_object_version: Optional[str] = None,
                   name: Optional[str] = None,
                   name_prefix: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewTrustStore(ctx *Context, name string, args TrustStoreArgs, opts ...ResourceOption) (*TrustStore, error)
    public TrustStore(string name, TrustStoreArgs args, CustomResourceOptions? opts = null)
    public TrustStore(String name, TrustStoreArgs args)
    public TrustStore(String name, TrustStoreArgs args, CustomResourceOptions options)
    
    type: aws:lb:TrustStore
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TrustStoreArgs
    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 TrustStoreArgs
    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 TrustStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrustStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrustStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var trustStoreResource = new Aws.LB.TrustStore("trustStoreResource", new()
    {
        CaCertificatesBundleS3Bucket = "string",
        CaCertificatesBundleS3Key = "string",
        CaCertificatesBundleS3ObjectVersion = "string",
        Name = "string",
        NamePrefix = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := lb.NewTrustStore(ctx, "trustStoreResource", &lb.TrustStoreArgs{
    	CaCertificatesBundleS3Bucket:        pulumi.String("string"),
    	CaCertificatesBundleS3Key:           pulumi.String("string"),
    	CaCertificatesBundleS3ObjectVersion: pulumi.String("string"),
    	Name:                                pulumi.String("string"),
    	NamePrefix:                          pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var trustStoreResource = new TrustStore("trustStoreResource", TrustStoreArgs.builder()
        .caCertificatesBundleS3Bucket("string")
        .caCertificatesBundleS3Key("string")
        .caCertificatesBundleS3ObjectVersion("string")
        .name("string")
        .namePrefix("string")
        .tags(Map.of("string", "string"))
        .build());
    
    trust_store_resource = aws.lb.TrustStore("trustStoreResource",
        ca_certificates_bundle_s3_bucket="string",
        ca_certificates_bundle_s3_key="string",
        ca_certificates_bundle_s3_object_version="string",
        name="string",
        name_prefix="string",
        tags={
            "string": "string",
        })
    
    const trustStoreResource = new aws.lb.TrustStore("trustStoreResource", {
        caCertificatesBundleS3Bucket: "string",
        caCertificatesBundleS3Key: "string",
        caCertificatesBundleS3ObjectVersion: "string",
        name: "string",
        namePrefix: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:lb:TrustStore
    properties:
        caCertificatesBundleS3Bucket: string
        caCertificatesBundleS3Key: string
        caCertificatesBundleS3ObjectVersion: string
        name: string
        namePrefix: string
        tags:
            string: string
    

    TrustStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TrustStore resource accepts the following input properties:

    CaCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    CaCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    CaCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    Name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CaCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    CaCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    CaCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    Name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    caCertificatesBundleS3Bucket String
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key String
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion String
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name String
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    caCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ca_certificates_bundle_s3_bucket str
    S3 Bucket name holding the client certificate CA bundle.
    ca_certificates_bundle_s3_key str
    S3 object key holding the client certificate CA bundle.
    ca_certificates_bundle_s3_object_version str
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name str
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    caCertificatesBundleS3Bucket String
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key String
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion String
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name String
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TrustStore resource produces the following output properties:

    Arn string
    ARN of the Trust Store (matches id).
    ArnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Trust Store (matches id).
    ArnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Trust Store (matches id).
    arnSuffix String
    ARN suffix for use with CloudWatch Metrics.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Trust Store (matches id).
    arnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Trust Store (matches id).
    arn_suffix str
    ARN suffix for use with CloudWatch Metrics.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Trust Store (matches id).
    arnSuffix String
    ARN suffix for use with CloudWatch Metrics.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing TrustStore Resource

    Get an existing TrustStore 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>, state?: TrustStoreState, opts?: CustomResourceOptions): TrustStore
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            arn_suffix: Optional[str] = None,
            ca_certificates_bundle_s3_bucket: Optional[str] = None,
            ca_certificates_bundle_s3_key: Optional[str] = None,
            ca_certificates_bundle_s3_object_version: Optional[str] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> TrustStore
    func GetTrustStore(ctx *Context, name string, id IDInput, state *TrustStoreState, opts ...ResourceOption) (*TrustStore, error)
    public static TrustStore Get(string name, Input<string> id, TrustStoreState? state, CustomResourceOptions? opts = null)
    public static TrustStore get(String name, Output<String> id, TrustStoreState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Trust Store (matches id).
    ArnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    CaCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    CaCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    CaCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    Name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Trust Store (matches id).
    ArnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    CaCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    CaCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    CaCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    Name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Trust Store (matches id).
    arnSuffix String
    ARN suffix for use with CloudWatch Metrics.
    caCertificatesBundleS3Bucket String
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key String
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion String
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name String
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Trust Store (matches id).
    arnSuffix string
    ARN suffix for use with CloudWatch Metrics.
    caCertificatesBundleS3Bucket string
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key string
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion string
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name string
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Trust Store (matches id).
    arn_suffix str
    ARN suffix for use with CloudWatch Metrics.
    ca_certificates_bundle_s3_bucket str
    S3 Bucket name holding the client certificate CA bundle.
    ca_certificates_bundle_s3_key str
    S3 object key holding the client certificate CA bundle.
    ca_certificates_bundle_s3_object_version str
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name str
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Trust Store (matches id).
    arnSuffix String
    ARN suffix for use with CloudWatch Metrics.
    caCertificatesBundleS3Bucket String
    S3 Bucket name holding the client certificate CA bundle.
    caCertificatesBundleS3Key String
    S3 object key holding the client certificate CA bundle.
    caCertificatesBundleS3ObjectVersion String
    Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted.
    name String
    Name of the Trust Store. If omitted, the provider will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name. Cannot be longer than 6 characters.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Target Groups using their ARN. For example:

    $ pulumi import aws:lb/trustStore:TrustStore example arn:aws:elasticloadbalancing:us-west-2:187416307283:truststore/my-trust-store/20cfe21448b66314
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi