aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
311 lines (310 loc) • 15.5 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { ChallengeReference, ConnectorReference, IChallengeRef, IConnectorRef } from "../../interfaces/generated/aws-pcaconnectorscep-interfaces.generated";
/**
* For general-purpose connectors.
*
* Creates a *challenge password* for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call [ListConnectors](https://docs.aws.amazon.com/pca-connector-scep/latest/APIReference/API_ListConnectors.html) .
*
* To create additional challenge passwords for the connector, call `CreateChallenge` again. We recommend frequently rotating your challenge passwords.
*
* @cloudformationResource AWS::PCAConnectorSCEP::Challenge
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html
*/
export declare class CfnChallenge extends cdk.CfnResource implements cdk.IInspectable, IChallengeRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnChallenge from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChallenge;
/**
* Checks whether the given object is a CfnChallenge
*/
static isCfnChallenge(x: any): x is CfnChallenge;
static arnForChallenge(resource: IChallengeRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The Amazon Resource Name (ARN) of the connector.
*/
private _connectorArn;
private _tags?;
/**
* Create a new `AWS::PCAConnectorSCEP::Challenge`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnChallengeProps);
get challengeRef(): ChallengeReference;
/**
* The Amazon Resource Name (ARN) of the connector.
*/
get connectorArn(): string;
/**
* The Amazon Resource Name (ARN) of the connector.
*/
set connectorArn(value: string);
get tags(): Record<string, string> | undefined;
set tags(value: Record<string, string> | undefined);
/**
* The Amazon Resource Name (ARN) of the challenge.
*
* @cloudformationAttribute ChallengeArn
*/
get attrChallengeArn(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnChallenge`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html
*/
export interface CfnChallengeProps {
/**
* The Amazon Resource Name (ARN) of the connector.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#cfn-pcaconnectorscep-challenge-connectorarn
*/
readonly connectorArn: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-challenge.html#cfn-pcaconnectorscep-challenge-tags
*/
readonly tags?: Record<string, string>;
}
/**
* Connector for SCEP is a service that links AWS Private Certificate Authority to your SCEP-enabled devices.
*
* The connector brokers the exchange of certificates from AWS Private CA to your SCEP-enabled devices and mobile device management systems. The connector is a complex type that contains the connector's configuration settings.
*
* @cloudformationResource AWS::PCAConnectorSCEP::Connector
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html
*/
export declare class CfnConnector extends cdk.CfnResource implements cdk.IInspectable, IConnectorRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnConnector from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnConnector;
/**
* Checks whether the given object is a CfnConnector
*/
static isCfnConnector(x: any): x is CfnConnector;
static arnForConnector(resource: IConnectorRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
*/
private _certificateAuthorityArn;
/**
* Contains settings relevant to the mobile device management system that you chose for the connector.
*/
private _mobileDeviceManagement?;
private _tags?;
private _vpcEndpointId?;
/**
* Create a new `AWS::PCAConnectorSCEP::Connector`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnConnectorProps);
get connectorRef(): ConnectorReference;
/**
* The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
*/
get certificateAuthorityArn(): string;
/**
* The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
*/
set certificateAuthorityArn(value: string);
/**
* Contains settings relevant to the mobile device management system that you chose for the connector.
*/
get mobileDeviceManagement(): cdk.IResolvable | CfnConnector.MobileDeviceManagementProperty | undefined;
/**
* Contains settings relevant to the mobile device management system that you chose for the connector.
*/
set mobileDeviceManagement(value: cdk.IResolvable | CfnConnector.MobileDeviceManagementProperty | undefined);
get tags(): Record<string, string> | undefined;
set tags(value: Record<string, string> | undefined);
get vpcEndpointId(): string | undefined;
set vpcEndpointId(value: string | undefined);
/**
* The Amazon Resource Name (ARN) of the connector.
*
* @cloudformationAttribute ConnectorArn
*/
get attrConnectorArn(): string;
/**
* The connector's HTTPS public SCEP URL.
*
* @cloudformationAttribute Endpoint
*/
get attrEndpoint(): string;
/**
* @cloudformationAttribute OpenIdConfiguration
*/
get attrOpenIdConfiguration(): cdk.IResolvable;
/**
* The connector type.
*
* @cloudformationAttribute Type
*/
get attrType(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnConnector {
/**
* If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use.
*
* A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see [Considerations and Limitations](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlc4scep-considerations-limitations.html) .
*
* If you provide an `IntuneConfiguration` , Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html
*/
interface MobileDeviceManagementProperty {
/**
* Configuration settings for use with Microsoft Intune.
*
* For information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-mobiledevicemanagement.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement-intune
*/
readonly intune: CfnConnector.IntuneConfigurationProperty | cdk.IResolvable;
}
/**
* Contains configuration details for use with Microsoft Intune.
*
* For information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html) .
*
* When you use Connector for SCEP for Microsoft Intune, certain functionalities are enabled by accessing Microsoft Intune through the Microsoft API. Your use of the Connector for SCEP and accompanying AWS services doesn't remove your need to have a valid license for your use of the Microsoft Intune service. You should also review the [Microsoft Intune® App Protection Policies](https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/mem/intune/apps/app-protection-policy) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html
*/
interface IntuneConfigurationProperty {
/**
* The directory (tenant) ID from your Microsoft Entra ID app registration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-azureapplicationid
*/
readonly azureApplicationId: string;
/**
* The primary domain from your Microsoft Entra ID app registration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-intuneconfiguration.html#cfn-pcaconnectorscep-connector-intuneconfiguration-domain
*/
readonly domain: string;
}
/**
* Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune.
*
* For more information about using Connector for SCEP for Microsoft Intune, see [Using Connector for SCEP for Microsoft Intune](https://docs.aws.amazon.com/privateca/latest/userguide/scep-connector.htmlconnector-for-scep-intune.html) .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html
*/
interface OpenIdConfigurationProperty {
/**
* The audience value to copy into your Microsoft Entra app registration's OIDC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-audience
*/
readonly audience?: string;
/**
* The issuer value to copy into your Microsoft Entra app registration's OIDC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-issuer
*/
readonly issuer?: string;
/**
* The subject value to copy into your Microsoft Entra app registration's OIDC.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcaconnectorscep-connector-openidconfiguration.html#cfn-pcaconnectorscep-connector-openidconfiguration-subject
*/
readonly subject?: string;
}
}
/**
* Properties for defining a `CfnConnector`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html
*/
export interface CfnConnectorProps {
/**
* The Amazon Resource Name (ARN) of the certificate authority associated with the connector.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-certificateauthorityarn
*/
readonly certificateAuthorityArn: string;
/**
* Contains settings relevant to the mobile device management system that you chose for the connector.
*
* If you didn't configure `MobileDeviceManagement` , then the connector is for general-purpose use and this object is empty.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-mobiledevicemanagement
*/
readonly mobileDeviceManagement?: cdk.IResolvable | CfnConnector.MobileDeviceManagementProperty;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-tags
*/
readonly tags?: Record<string, string>;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcaconnectorscep-connector.html#cfn-pcaconnectorscep-connector-vpcendpointid
*/
readonly vpcEndpointId?: string;
}
export type { IChallengeRef, ChallengeReference };
export type { IConnectorRef, ConnectorReference };