Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. Alias

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.Alias

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM-encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated. Set Content-Type: application/json and include CertificateGenerationSpec in the request body. Auto-naming is currently not supported for this resource.

    Create Alias Resource

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

    Constructor syntax

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

@overload
def Alias(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          environment_id: Optional[str] = None,
          format: Optional[str] = None,
          keystore_id: Optional[str] = None,
          organization_id: Optional[str] = None,
          alias: Optional[str] = None,
          content_type: Optional[str] = None,
          data: Optional[str] = None,
          extensions: Optional[Sequence[Mapping[str, str]]] = None,
          file: Optional[Union[pulumi.Asset, pulumi.Archive]] = None,
          ignore_expiry_validation: Optional[bool] = None,
          ignore_newline_validation: Optional[bool] = None,
          password: Optional[str] = None)
    func NewAlias(ctx *Context, name string, args AliasArgs, opts ...ResourceOption) (*Alias, error)
    public Alias(string name, AliasArgs args, CustomResourceOptions? opts = null)
    public Alias(String name, AliasArgs args)
public Alias(String name, AliasArgs args, CustomResourceOptions options)

    type: google-native:apigee/v1:Alias
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 AliasArgs
    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 AliasArgs
    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 AliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AliasArgs
    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 aliasResource = new GoogleNative.Apigee.V1.Alias("aliasResource", new()
{
    EnvironmentId = "string",
    Format = "string",
    KeystoreId = "string",
    OrganizationId = "string",
    Alias = "string",
    ContentType = "string",
    Data = "string",
    Extensions = new[]
    {
        
        {
            { "string", "string" },
        },
    },
    File = new StringAsset("content"),
    IgnoreExpiryValidation = false,
    IgnoreNewlineValidation = false,
    Password = "string",
});

    example, err := apigee.NewAlias(ctx, "aliasResource", &apigee.AliasArgs{
	EnvironmentId:  pulumi.String("string"),
	Format:         pulumi.String("string"),
	KeystoreId:     pulumi.String("string"),
	OrganizationId: pulumi.String("string"),
	Alias:          pulumi.String("string"),
	ContentType:    pulumi.String("string"),
	Data:           pulumi.String("string"),
	Extensions: pulumi.StringMapArray{
		pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	File:                    pulumi.NewStringAsset("content"),
	IgnoreExpiryValidation:  pulumi.Bool(false),
	IgnoreNewlineValidation: pulumi.Bool(false),
	Password:                pulumi.String("string"),
})

    var aliasResource = new Alias("aliasResource", AliasArgs.builder()
    .environmentId("string")
    .format("string")
    .keystoreId("string")
    .organizationId("string")
    .alias("string")
    .contentType("string")
    .data("string")
    .extensions(Map.of("string", "string"))
    .file(new StringAsset("content"))
    .ignoreExpiryValidation(false)
    .ignoreNewlineValidation(false)
    .password("string")
    .build());

    alias_resource = google_native.apigee.v1.Alias("aliasResource",
    environment_id="string",
    format="string",
    keystore_id="string",
    organization_id="string",
    alias="string",
    content_type="string",
    data="string",
    extensions=[{
        "string": "string",
    }],
    file=pulumi.StringAsset("content"),
    ignore_expiry_validation=False,
    ignore_newline_validation=False,
    password="string")

    const aliasResource = new google_native.apigee.v1.Alias("aliasResource", {
    environmentId: "string",
    format: "string",
    keystoreId: "string",
    organizationId: "string",
    alias: "string",
    contentType: "string",
    data: "string",
    extensions: [{
        string: "string",
    }],
    file: new pulumi.asset.StringAsset("content"),
    ignoreExpiryValidation: false,
    ignoreNewlineValidation: false,
    password: "string",
});

    type: google-native:apigee/v1:Alias
properties:
    alias: string
    contentType: string
    data: string
    environmentId: string
    extensions:
        - string: string
    file:
        fn::StringAsset: content
    format: string
    ignoreExpiryValidation: false
    ignoreNewlineValidation: false
    keystoreId: string
    organizationId: string
    password: string

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

    EnvironmentId string
    Format string
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    KeystoreId string
    OrganizationId string
    Alias string
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    ContentType string
    The HTTP Content-Type header value specifying the content type of the body.
    Data string
    The HTTP request/response body as raw binary.
    Extensions List<ImmutableDictionary<string, string>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    File AssetOrArchive
    File to upload.
    IgnoreExpiryValidation bool
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    IgnoreNewlineValidation bool
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    Password string
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.
    EnvironmentId string
    Format string
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    KeystoreId string
    OrganizationId string
    Alias string
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    ContentType string
    The HTTP Content-Type header value specifying the content type of the body.
    Data string
    The HTTP request/response body as raw binary.
    Extensions []map[string]string
    Application specific response metadata. Must be set in the first response for streaming APIs.
    File pulumi.AssetOrArchive
    File to upload.
    IgnoreExpiryValidation bool
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    IgnoreNewlineValidation bool
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    Password string
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.
    environmentId String
    format String
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    keystoreId String
    organizationId String
    alias String
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    contentType String
    The HTTP Content-Type header value specifying the content type of the body.
    data String
    The HTTP request/response body as raw binary.
    extensions List<Map<String,String>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file AssetOrArchive
    File to upload.
    ignoreExpiryValidation Boolean
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    ignoreNewlineValidation Boolean
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    password String
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.
    environmentId string
    format string
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    keystoreId string
    organizationId string
    alias string
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    contentType string
    The HTTP Content-Type header value specifying the content type of the body.
    data string
    The HTTP request/response body as raw binary.
    extensions {[key: string]: string}[]
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file pulumi.asset.Asset | pulumi.asset.Archive
    File to upload.
    ignoreExpiryValidation boolean
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    ignoreNewlineValidation boolean
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    password string
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.
    environment_id str
    format str
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    keystore_id str
    organization_id str
    alias str
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    content_type str
    The HTTP Content-Type header value specifying the content type of the body.
    data str
    The HTTP request/response body as raw binary.
    extensions Sequence[Mapping[str, str]]
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file Union[pulumi.Asset, pulumi.Archive]
    File to upload.
    ignore_expiry_validation bool
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    ignore_newline_validation bool
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    password str
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.
    environmentId String
    format String
    Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12
    keystoreId String
    organizationId String
    alias String
    Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.
    contentType String
    The HTTP Content-Type header value specifying the content type of the body.
    data String
    The HTTP request/response body as raw binary.
    extensions List<Map<String>>
    Application specific response metadata. Must be set in the first response for streaming APIs.
    file Asset
    File to upload.
    ignoreExpiryValidation Boolean
    Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.
    ignoreNewlineValidation Boolean
    Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.
    password String
    DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.

    Outputs

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

    CertsInfo Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1CertificateResponse
    Chain of certificates under this alias.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of alias.
    CertsInfo GoogleCloudApigeeV1CertificateResponse
    Chain of certificates under this alias.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Type of alias.
    certsInfo GoogleCloudApigeeV1CertificateResponse
    Chain of certificates under this alias.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of alias.
    certsInfo GoogleCloudApigeeV1CertificateResponse
    Chain of certificates under this alias.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Type of alias.
    certs_info GoogleCloudApigeeV1CertificateResponse
    Chain of certificates under this alias.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Type of alias.
    certsInfo Property Map
    Chain of certificates under this alias.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Type of alias.

    Supporting Types

    GoogleCloudApigeeV1CertInfoResponse, GoogleCloudApigeeV1CertInfoResponseArgs

    BasicConstraints string
    X.509 basic constraints extension.
    ExpiryDate string
    X.509 notAfter validity period in milliseconds since epoch.
    IsValid string
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    Issuer string
    X.509 issuer.
    PublicKey string
    Public key component of the X.509 subject public key info.
    SerialNumber string
    X.509 serial number.
    SigAlgName string
    X.509 signatureAlgorithm.
    Subject string
    X.509 subject.
    SubjectAlternativeNames List<string>
    X.509 subject alternative names (SANs) extension.
    ValidFrom string
    X.509 notBefore validity period in milliseconds since epoch.
    Version int
    X.509 version.
    BasicConstraints string
    X.509 basic constraints extension.
    ExpiryDate string
    X.509 notAfter validity period in milliseconds since epoch.
    IsValid string
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    Issuer string
    X.509 issuer.
    PublicKey string
    Public key component of the X.509 subject public key info.
    SerialNumber string
    X.509 serial number.
    SigAlgName string
    X.509 signatureAlgorithm.
    Subject string
    X.509 subject.
    SubjectAlternativeNames []string
    X.509 subject alternative names (SANs) extension.
    ValidFrom string
    X.509 notBefore validity period in milliseconds since epoch.
    Version int
    X.509 version.
    basicConstraints String
    X.509 basic constraints extension.
    expiryDate String
    X.509 notAfter validity period in milliseconds since epoch.
    isValid String
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    issuer String
    X.509 issuer.
    publicKey String
    Public key component of the X.509 subject public key info.
    serialNumber String
    X.509 serial number.
    sigAlgName String
    X.509 signatureAlgorithm.
    subject String
    X.509 subject.
    subjectAlternativeNames List<String>
    X.509 subject alternative names (SANs) extension.
    validFrom String
    X.509 notBefore validity period in milliseconds since epoch.
    version Integer
    X.509 version.
    basicConstraints string
    X.509 basic constraints extension.
    expiryDate string
    X.509 notAfter validity period in milliseconds since epoch.
    isValid string
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    issuer string
    X.509 issuer.
    publicKey string
    Public key component of the X.509 subject public key info.
    serialNumber string
    X.509 serial number.
    sigAlgName string
    X.509 signatureAlgorithm.
    subject string
    X.509 subject.
    subjectAlternativeNames string[]
    X.509 subject alternative names (SANs) extension.
    validFrom string
    X.509 notBefore validity period in milliseconds since epoch.
    version number
    X.509 version.
    basic_constraints str
    X.509 basic constraints extension.
    expiry_date str
    X.509 notAfter validity period in milliseconds since epoch.
    is_valid str
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    issuer str
    X.509 issuer.
    public_key str
    Public key component of the X.509 subject public key info.
    serial_number str
    X.509 serial number.
    sig_alg_name str
    X.509 signatureAlgorithm.
    subject str
    X.509 subject.
    subject_alternative_names Sequence[str]
    X.509 subject alternative names (SANs) extension.
    valid_from str
    X.509 notBefore validity period in milliseconds since epoch.
    version int
    X.509 version.
    basicConstraints String
    X.509 basic constraints extension.
    expiryDate String
    X.509 notAfter validity period in milliseconds since epoch.
    isValid String
    Flag that specifies whether the certificate is valid. Flag is set to Yes if the certificate is valid, No if expired, or Not yet if not yet valid.
    issuer String
    X.509 issuer.
    publicKey String
    Public key component of the X.509 subject public key info.
    serialNumber String
    X.509 serial number.
    sigAlgName String
    X.509 signatureAlgorithm.
    subject String
    X.509 subject.
    subjectAlternativeNames List<String>
    X.509 subject alternative names (SANs) extension.
    validFrom String
    X.509 notBefore validity period in milliseconds since epoch.
    version Number
    X.509 version.

    GoogleCloudApigeeV1CertificateResponse, GoogleCloudApigeeV1CertificateResponseArgs

    CertInfo []GoogleCloudApigeeV1CertInfoResponse
    Chain of certificates under this name.
    certInfo List<GoogleCloudApigeeV1CertInfoResponse>
    Chain of certificates under this name.
    certInfo GoogleCloudApigeeV1CertInfoResponse[]
    Chain of certificates under this name.
    cert_info Sequence[GoogleCloudApigeeV1CertInfoResponse]
    Chain of certificates under this name.
    certInfo List<Property Map>
    Chain of certificates under this name.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native