ICodeInterpreterCustom Interface
Interface for CodeInterpreterCustom resources.
Properties
codeInterpreterArnstringcode_interpreter_arnstrcodeInterpreterArnStringCodeInterpreterArnstringCodeInterpreterArn*stringrequired#The ARN of the code interpreter resource.
codeInterpreterCustomRefCodeInterpreterCustomReferencecode_interpreter_custom_refCodeInterpreterCustomReferencecodeInterpreterCustomRefCodeInterpreterCustomReferenceCodeInterpreterCustomRefCodeInterpreterCustomReferenceCodeInterpreterCustomRefCodeInterpreterCustomReferencerequired#A reference to a CodeInterpreterCustom resource.
codeInterpreterIdstringcode_interpreter_idstrcodeInterpreterIdStringCodeInterpreterIdstringCodeInterpreterId*stringrequired#The id of the code interpreter.
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#The network connections associated with this resource.
Timestamp when the code interpreter was created.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRolerequired#The IAM role that provides permissions for the code interpreter to access AWS services.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#The principal to grant permissions to.
Timestamp when the code interpreter was last updated.
The stack in which this resource is defined.
The status of the code interpreter.
Methods
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#Grants IAM actions to the IAM Principal.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#Grants `Get` and `List` actions on the Code Interpreter.
grantUse(grantee: IGrantable): Grantdef grant_use(self, grantee: IGrantable) -> Grantpublic Grant grantUse(IGrantable grantee)public Grant GrantUse(IGrantable grantee)func GrantUse(Grantee IGrantable) Grant#Grants `Invoke`, `Start`, and `Stop` actions on the Code Interpreter.
metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#Return the given named metric for this code interpreter.
metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_errors_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricErrorsForApiOperation(String operation, MetricOptions props)public Metric MetricErrorsForApiOperation(string operation, MetricOptions? props = null)func MetricErrorsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the number of errors for a specific API operation performed on this code interpreter.
metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metricdef metric_for_api_operation(self, metric_name: str, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricForApiOperation(String metricName, String operation, MetricOptions props)public Metric MetricForApiOperation(string metricName, string operation, MetricOptions? props = null)func MetricForApiOperation(MetricName *string, Operation *string, Props MetricOptions) Metric#Return the given named metric related to the API operation performed on this code interpreter.
metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_invocations_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationsForApiOperation(String operation, MetricOptions props)public Metric MetricInvocationsForApiOperation(string operation, MetricOptions? props = null)func MetricInvocationsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the total number of API requests made for a specific code interpreter operation.
metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_latency_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricLatencyForApiOperation(String operation, MetricOptions props)public Metric MetricLatencyForApiOperation(string operation, MetricOptions? props = null)func MetricLatencyForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric measuring the latency of a specific API operation performed on this code interpreter.
metricSessionDuration(props?: MetricOptions): Metricdef metric_session_duration(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSessionDuration(MetricOptions props)public Metric MetricSessionDuration(MetricOptions? props = null)func MetricSessionDuration(Props MetricOptions) Metric#Return a metric measuring the duration of code interpreter sessions.
metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_system_errors_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricSystemErrorsForApiOperation(String operation, MetricOptions props)public Metric MetricSystemErrorsForApiOperation(string operation, MetricOptions? props = null)func MetricSystemErrorsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the number of system errors for a specific API operation performed on this code interpreter.
metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_throttles_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricThrottlesForApiOperation(String operation, MetricOptions props)public Metric MetricThrottlesForApiOperation(string operation, MetricOptions? props = null)func MetricThrottlesForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the number of throttled requests for a specific API operation performed on this code interpreter.
metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_user_errors_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricUserErrorsForApiOperation(String operation, MetricOptions props)public Metric MetricUserErrorsForApiOperation(string operation, MetricOptions? props = null)func MetricUserErrorsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the number of user errors for a specific API operation performed on this code interpreter.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.
1 parameter · returns
Parameters
mixinsmixinsmixinsmixinsMixins— The mixins to apply.
Returns: This construct for chaining