Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fastly Provider
  3. API Docs
  4. TlsMutualAuthentication
Fastly v8.13.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-fastly

fastly.TlsMutualAuthentication

Explore with Pulumi AI

fastly logo
Fastly v8.13.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-fastly

    The Mutual TLS API allows for client-to-server authentication using client-side X.509 authentication.

    The main Mutual Authentication object represents the certificate bundle and other configurations which support Mutual TLS for your domains.

    Mutual TLS can be added to existing TLS activations to allow for client-to-server authentication. In order to use mutual TLS, you must already have active server-side TLS using either custom certificates or an enabled Fastly-managed subscription.

    The examples below demonstrate how to use Mutual Authentication along with a TLS Subscription. Refer to the fastly.TlsSubscription resource documentation for a deeper explanation of that code.

    Create TlsMutualAuthentication Resource

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

    Constructor syntax

    new TlsMutualAuthentication(name: string, args: TlsMutualAuthenticationArgs, opts?: CustomResourceOptions);
    @overload
def TlsMutualAuthentication(resource_name: str,
                            args: TlsMutualAuthenticationArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def TlsMutualAuthentication(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cert_bundle: Optional[str] = None,
                            activation_ids: Optional[Sequence[str]] = None,
                            enforced: Optional[bool] = None,
                            include: Optional[str] = None,
                            name: Optional[str] = None)
    func NewTlsMutualAuthentication(ctx *Context, name string, args TlsMutualAuthenticationArgs, opts ...ResourceOption) (*TlsMutualAuthentication, error)
    public TlsMutualAuthentication(string name, TlsMutualAuthenticationArgs args, CustomResourceOptions? opts = null)
    public TlsMutualAuthentication(String name, TlsMutualAuthenticationArgs args)
public TlsMutualAuthentication(String name, TlsMutualAuthenticationArgs args, CustomResourceOptions options)

    type: fastly:TlsMutualAuthentication
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 TlsMutualAuthenticationArgs
    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 TlsMutualAuthenticationArgs
    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 TlsMutualAuthenticationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TlsMutualAuthenticationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TlsMutualAuthenticationArgs
    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 tlsMutualAuthenticationResource = new Fastly.TlsMutualAuthentication("tlsMutualAuthenticationResource", new()
{
    CertBundle = "string",
    ActivationIds = new[]
    {
        "string",
    },
    Enforced = false,
    Include = "string",
    Name = "string",
});

    example, err := fastly.NewTlsMutualAuthentication(ctx, "tlsMutualAuthenticationResource", &fastly.TlsMutualAuthenticationArgs{
	CertBundle: pulumi.String("string"),
	ActivationIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Enforced: pulumi.Bool(false),
	Include:  pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var tlsMutualAuthenticationResource = new TlsMutualAuthentication("tlsMutualAuthenticationResource", TlsMutualAuthenticationArgs.builder()
    .certBundle("string")
    .activationIds("string")
    .enforced(false)
    .include("string")
    .name("string")
    .build());

    tls_mutual_authentication_resource = fastly.TlsMutualAuthentication("tlsMutualAuthenticationResource",
    cert_bundle="string",
    activation_ids=["string"],
    enforced=False,
    include="string",
    name="string")

    const tlsMutualAuthenticationResource = new fastly.TlsMutualAuthentication("tlsMutualAuthenticationResource", {
    certBundle: "string",
    activationIds: ["string"],
    enforced: false,
    include: "string",
    name: "string",
});

    type: fastly:TlsMutualAuthentication
properties:
    activationIds:
        - string
    certBundle: string
    enforced: false
    include: string
    name: string

    TlsMutualAuthentication 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 TlsMutualAuthentication resource accepts the following input properties:

    CertBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    ActivationIds List<string>
    List of TLS Activation IDs
    Enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    Include string
    Name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    CertBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    ActivationIds []string
    List of TLS Activation IDs
    Enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    Include string
    Name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    certBundle String
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    activationIds List<String>
    List of TLS Activation IDs
    enforced Boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include String
    name String
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    certBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    activationIds string[]
    List of TLS Activation IDs
    enforced boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include string
    name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    cert_bundle str
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    activation_ids Sequence[str]
    List of TLS Activation IDs
    enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include str
    name str
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    certBundle String
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    activationIds List<String>
    List of TLS Activation IDs
    enforced Boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include String
    name String
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.

    Outputs

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

    CreatedAt string
    Date and time in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TlsActivations List<string>
    List of alphanumeric strings identifying TLS activations.
    UpdatedAt string
    Date and time in ISO 8601 format.
    CreatedAt string
    Date and time in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TlsActivations []string
    List of alphanumeric strings identifying TLS activations.
    UpdatedAt string
    Date and time in ISO 8601 format.
    createdAt String
    Date and time in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tlsActivations List<String>
    List of alphanumeric strings identifying TLS activations.
    updatedAt String
    Date and time in ISO 8601 format.
    createdAt string
    Date and time in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    tlsActivations string[]
    List of alphanumeric strings identifying TLS activations.
    updatedAt string
    Date and time in ISO 8601 format.
    created_at str
    Date and time in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    tls_activations Sequence[str]
    List of alphanumeric strings identifying TLS activations.
    updated_at str
    Date and time in ISO 8601 format.
    createdAt String
    Date and time in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tlsActivations List<String>
    List of alphanumeric strings identifying TLS activations.
    updatedAt String
    Date and time in ISO 8601 format.

    Look up Existing TlsMutualAuthentication Resource

    Get an existing TlsMutualAuthentication 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?: TlsMutualAuthenticationState, opts?: CustomResourceOptions): TlsMutualAuthentication
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_ids: Optional[Sequence[str]] = None,
        cert_bundle: Optional[str] = None,
        created_at: Optional[str] = None,
        enforced: Optional[bool] = None,
        include: Optional[str] = None,
        name: Optional[str] = None,
        tls_activations: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None) -> TlsMutualAuthentication
    func GetTlsMutualAuthentication(ctx *Context, name string, id IDInput, state *TlsMutualAuthenticationState, opts ...ResourceOption) (*TlsMutualAuthentication, error)
    public static TlsMutualAuthentication Get(string name, Input<string> id, TlsMutualAuthenticationState? state, CustomResourceOptions? opts = null)
    public static TlsMutualAuthentication get(String name, Output<String> id, TlsMutualAuthenticationState 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:
    ActivationIds List<string>
    List of TLS Activation IDs
    CertBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    CreatedAt string
    Date and time in ISO 8601 format.
    Enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    Include string
    Name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    TlsActivations List<string>
    List of alphanumeric strings identifying TLS activations.
    UpdatedAt string
    Date and time in ISO 8601 format.
    ActivationIds []string
    List of TLS Activation IDs
    CertBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    CreatedAt string
    Date and time in ISO 8601 format.
    Enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    Include string
    Name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    TlsActivations []string
    List of alphanumeric strings identifying TLS activations.
    UpdatedAt string
    Date and time in ISO 8601 format.
    activationIds List<String>
    List of TLS Activation IDs
    certBundle String
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    createdAt String
    Date and time in ISO 8601 format.
    enforced Boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include String
    name String
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    tlsActivations List<String>
    List of alphanumeric strings identifying TLS activations.
    updatedAt String
    Date and time in ISO 8601 format.
    activationIds string[]
    List of TLS Activation IDs
    certBundle string
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    createdAt string
    Date and time in ISO 8601 format.
    enforced boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include string
    name string
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    tlsActivations string[]
    List of alphanumeric strings identifying TLS activations.
    updatedAt string
    Date and time in ISO 8601 format.
    activation_ids Sequence[str]
    List of TLS Activation IDs
    cert_bundle str
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    created_at str
    Date and time in ISO 8601 format.
    enforced bool
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include str
    name str
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    tls_activations Sequence[str]
    List of alphanumeric strings identifying TLS activations.
    updated_at str
    Date and time in ISO 8601 format.
    activationIds List<String>
    List of TLS Activation IDs
    certBundle String
    One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted.
    createdAt String
    Date and time in ISO 8601 format.
    enforced Boolean
    Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed (if this attribute is not set we default to false).
    include String
    name String
    A custom name for your mutual authentication. If name is not supplied we will auto-generate one.
    tlsActivations List<String>
    List of alphanumeric strings identifying TLS activations.
    updatedAt String
    Date and time in ISO 8601 format.

    Package Details

    Repository
    Fastly pulumi/pulumi-fastly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fastly Terraform Provider.
    fastly logo
    Fastly v8.13.0 published on Wednesday, Nov 13, 2024 by Pulumi
    pulumi/pulumi-fastly